co.cask.cdap.security.spi.authorization

Class AbstractAuthorizer

java.lang.Object

co.cask.cdap.security.spi.authorization.AbstractAuthorizer

All Implemented Interfaces:

AuthorizationEnforcer, Authorizer, PrivilegesFetcher, PrivilegesManager

Direct Known Subclasses:

NoOpAuthorizer

public abstract class AbstractAuthorizer
extends Object
implements Authorizer

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Predicate<EntityId>	ALLOW_ALL

Constructor Summary

Constructors

Constructor and Description
AbstractAuthorizer()

Method Summary

Methods

Modifier and Type	Method and Description
Predicate<EntityId>	createFilter(Principal principal) 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.
void	destroy() Default no-op implementation of Authorizer.destroy().
void	enforce(EntityId entity, Principal principal, Action action) Enforces authorization for the specified Principal for the specified Action on the specified EntityId.
void	initialize(AuthorizationContext context) Default no-op implementation of Authorizer.initialize(AuthorizationContext).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.cask.cdap.security.spi.authorization.Authorizer

addRoleToPrincipal, createRole, dropRole, listAllRoles, listRoles, removeRoleFromPrincipal

Methods inherited from interface co.cask.cdap.security.spi.authorization.PrivilegesFetcher

listPrivileges

Methods inherited from interface co.cask.cdap.security.spi.authorization.PrivilegesManager

grant, revoke, revoke

Methods inherited from interface co.cask.cdap.security.spi.authorization.AuthorizationEnforcer

enforce

Field Detail

ALLOW_ALL

protected static final Predicate<EntityId> ALLOW_ALL

Constructor Detail

AbstractAuthorizer

public AbstractAuthorizer()

Method Detail

initialize

public void initialize(AuthorizationContext context)
                throws Exception

Default no-op implementation of Authorizer.initialize(AuthorizationContext).

Specified by:

initialize in interface Authorizer

Parameters:

context - the AuthorizationContext that can be used to interact with CDAP

Throws:

Exception

destroy

public void destroy()
             throws Exception

Default no-op implementation of Authorizer.destroy().

Specified by:

destroy in interface Authorizer

Throws:

Exception

enforce

public void enforce(EntityId entity,
           Principal principal,
           Action action)
             throws Exception

Description copied from interface: AuthorizationEnforcer

Enforces authorization for the specified Principal for the specified Action on the specified EntityId.

Specified by:

enforce in interface AuthorizationEnforcer

Parameters:

entity - the EntityId on which authorization is to be enforced

principal - the Principal that performs the action

action - the Action being performed

Throws:

UnauthorizedException - if the principal is not authorized to perform the specified action on the entity

Exception - if any other errors occurred while performing the authorization enforcement check

createFilter

public Predicate<EntityId> createFilter(Principal principal)
                                 throws Exception

Description copied from interface: 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.

Specified by:

createFilter in interface AuthorizationEnforcer

Parameters:

principal - the Principal for which to filter

Returns:

a set of entities that the specified user has access to

Throws:

Exception