Index (CDAP Security SPI 4.1.0 API)

A C D E G I L N P R S T U

A

AbstractAuthorizer - Class in co.cask.cdap.security.spi.authorization: Abstract class that implements Authorizer and provides default no-op implementations of Authorizer.initialize(AuthorizationContext) and Authorizer.destroy() so classes extending it do not have to implement these methods unless necessary.
AbstractAuthorizer() - Constructor for class co.cask.cdap.security.spi.authorization.AbstractAuthorizer
addRoleToPrincipal(Role, Principal) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Add a role to the specified Principal.
addRoleToPrincipal(Role, Principal) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
ALLOW_ALL - Static variable in class co.cask.cdap.security.spi.authorization.AbstractAuthorizer
AuthenticationContext - Interface in co.cask.cdap.security.spi.authentication: A context that determines authentication details.
AuthorizationContext - Interface in co.cask.cdap.security.spi.authorization: A context for Authorizer extensions to interact with CDAP.
AuthorizationEnforcer - Interface in co.cask.cdap.security.spi.authorization: Enforces authorization for a Principal to perform an Action on an EntityId.
Authorizer - Interface in co.cask.cdap.security.spi.authorization: Interface for managing principals' authorization for actions on CDAP entities.

C

co.cask.cdap.security.spi.authentication - package co.cask.cdap.security.spi.authentication
co.cask.cdap.security.spi.authorization - package co.cask.cdap.security.spi.authorization
createFilter(Principal) - Method in class co.cask.cdap.security.spi.authorization.AbstractAuthorizer
createFilter(Principal) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationEnforcer: Returns a Predicate that can be used to filter a set of entities to only return the entities that the specified Principal has access (READ/WRITE/ADMIN/ALL) to.
createFilter(Principal) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
createRole(Role) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Create a role.
createRole(Role) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
createTopic(String) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Currently messaging is not supported.
createTopic(String, Map<String, String>) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Currently messaging is not supported.

D

deleteTopic(String) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Currently messaging is not supported.
destroy() - Method in class co.cask.cdap.security.spi.authorization.AbstractAuthorizer: Default no-op implementation of Authorizer.destroy().
destroy() - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Destroys an Authorizer.
dropRole(Role) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Drop a role.
dropRole(Role) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer

E

enforce(EntityId, Principal, Action) - Method in class co.cask.cdap.security.spi.authorization.AbstractAuthorizer
enforce(EntityId, Principal, Action) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationEnforcer: Enforces authorization for the specified Principal for the specified Action on the specified EntityId.
enforce(EntityId, Principal, Set<Action>) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationEnforcer: Enforces authorization for the specified Principal for the specified actions on the specified EntityId.
enforce(EntityId, Principal, Set<Action>) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer

G

getExtensionProperties() - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Returns the properties for the authorization extension.
getPrincipal() - Method in interface co.cask.cdap.security.spi.authentication.AuthenticationContext: Determines the Principal making the authorization request.
getStatusCode() - Method in exception co.cask.cdap.security.spi.authorization.RoleAlreadyExistsException
getStatusCode() - Method in exception co.cask.cdap.security.spi.authorization.RoleNotFoundException
getStatusCode() - Method in exception co.cask.cdap.security.spi.authorization.UnauthorizedException
getTopicProperties(String) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Currently messaging is not supported.
getUserId() - Static method in class co.cask.cdap.security.spi.authentication.SecurityRequestContext
getUserIP() - Static method in class co.cask.cdap.security.spi.authentication.SecurityRequestContext
grant(EntityId, Principal, Set<Action>) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
grant(EntityId, Principal, Set<Action>) - Method in interface co.cask.cdap.security.spi.authorization.PrivilegesManager: Grants a Principal authorization to perform a set of actions on an EntityId.

I

initialize(AuthorizationContext) - Method in class co.cask.cdap.security.spi.authorization.AbstractAuthorizer: Default no-op implementation of Authorizer.initialize(AuthorizationContext).
initialize(AuthorizationContext) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Initialize the Authorizer.

L

listAllRoles() - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Returns all available Role.
listAllRoles() - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
listPrivileges(Principal) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
listPrivileges(Principal) - Method in interface co.cask.cdap.security.spi.authorization.PrivilegesFetcher: Returns all the Privilege for the specified Principal.
listRoles(Principal) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Returns a set of all roles for the specified Principal.
listRoles(Principal) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer

N

NoOpAuthorizer - Class in co.cask.cdap.security.spi.authorization: A no-op authorizer to use when authorization is disabled.
NoOpAuthorizer() - Constructor for class co.cask.cdap.security.spi.authorization.NoOpAuthorizer

P

PrivilegesFetcher - Interface in co.cask.cdap.security.spi.authorization: Fetches privileges of the specified Principal.
PrivilegesManager - Interface in co.cask.cdap.security.spi.authorization: Interface for managing privileges on entities.

R

removeRoleFromPrincipal(Role, Principal) - Method in interface co.cask.cdap.security.spi.authorization.Authorizer: Delete a role from the specified Principal.
removeRoleFromPrincipal(Role, Principal) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
revoke(EntityId, Principal, Set<Action>) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
revoke(EntityId) - Method in class co.cask.cdap.security.spi.authorization.NoOpAuthorizer
revoke(EntityId, Principal, Set<Action>) - Method in interface co.cask.cdap.security.spi.authorization.PrivilegesManager: Revokes a principal's authorization to perform a set of actions on an EntityId.
revoke(EntityId) - Method in interface co.cask.cdap.security.spi.authorization.PrivilegesManager: Revokes all principals' authorization to perform any Action on the given EntityId.
RoleAlreadyExistsException - Exception in co.cask.cdap.security.spi.authorization: Exception thrown when an Role already exists
RoleAlreadyExistsException(Role) - Constructor for exception co.cask.cdap.security.spi.authorization.RoleAlreadyExistsException
RoleNotFoundException - Exception in co.cask.cdap.security.spi.authorization: Exception thrown when a Role is not found
RoleNotFoundException(Role) - Constructor for exception co.cask.cdap.security.spi.authorization.RoleNotFoundException

S

SecurityRequestContext - Class in co.cask.cdap.security.spi.authentication: RequestContext that maintains a ThreadLocal SecurityRequestContext.userId and SecurityRequestContext.userIP of the authenticated user.
setUserId(String) - Static method in class co.cask.cdap.security.spi.authentication.SecurityRequestContext: Set the userId on the current thread.
setUserIP(String) - Static method in class co.cask.cdap.security.spi.authentication.SecurityRequestContext: Set the userIP on the current thread.

T

toPrincipal() - Static method in class co.cask.cdap.security.spi.authentication.SecurityRequestContext: Returns a Principal for the user set on the current thread

U

UnauthorizedException - Exception in co.cask.cdap.security.spi.authorization: Exception thrown when Authentication is successful, but a Principal is not authorized to perform an Action on an EntityId.
UnauthorizedException(Principal, Action, EntityId) - Constructor for exception co.cask.cdap.security.spi.authorization.UnauthorizedException
UnauthorizedException(Principal, Set<Action>, EntityId) - Constructor for exception co.cask.cdap.security.spi.authorization.UnauthorizedException
UnauthorizedException(Principal, EntityId) - Constructor for exception co.cask.cdap.security.spi.authorization.UnauthorizedException
UnauthorizedException(String) - Constructor for exception co.cask.cdap.security.spi.authorization.UnauthorizedException
updateTopic(String, Map<String, String>) - Method in interface co.cask.cdap.security.spi.authorization.AuthorizationContext: Currently messaging is not supported.

A C D E G I L N P R S T U