co.cask.cdap.security.spi.authorization

Class NoOpAuthorizer

java.lang.Object

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

co.cask.cdap.security.spi.authorization.NoOpAuthorizer

All Implemented Interfaces:

AuthorizationEnforcer, Authorizer, PrivilegesFetcher, PrivilegesManager

public class NoOpAuthorizer
extends AbstractAuthorizer

A no-op authorizer to use when authorization is disabled.

Field Summary

Fields inherited from class co.cask.cdap.security.spi.authorization.AbstractAuthorizer

ALLOW_ALL

Constructor Summary

Constructors

Constructor and Description
NoOpAuthorizer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleToPrincipal(Role role, Principal principal) Add a role to the specified Principal.
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	createRole(Role role) Create a role.
void	dropRole(Role role) Drop a role.
void	enforce(EntityId entity, Principal principal, Set<Action> actions) Enforces authorization for the specified Principal for the specified actions on the specified EntityId.
void	grant(EntityId entity, Principal principal, Set<Action> actions) Grants a Principal authorization to perform a set of actions on an EntityId.
Set<Role>	listAllRoles() Returns all available Role.
Set<Privilege>	listPrivileges(Principal principal) Returns all the Privilege for the specified Principal.
Set<Role>	listRoles(Principal principal) Returns a set of all roles for the specified Principal.
void	removeRoleFromPrincipal(Role role, Principal principal) Delete a role from the specified Principal.
void	revoke(EntityId entity) Revokes all principals' authorization to perform any Action on the given EntityId.
void	revoke(EntityId entity, Principal principal, Set<Action> actions) Revokes a principal's authorization to perform a set of actions on an EntityId.

Methods inherited from class co.cask.cdap.security.spi.authorization.AbstractAuthorizer

destroy, enforce, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpAuthorizer

public NoOpAuthorizer()

Method Detail

enforce

public void enforce(EntityId entity,
           Principal principal,
           Set<Action> actions)
             throws Exception

Description copied from interface: AuthorizationEnforcer

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

Parameters:

entity - the EntityId on which authorization is to be enforced

principal - the Principal that performs the actions

actions - the actions being performed

Throws:

UnauthorizedException - if the principal is not authorized to perform the specified actions 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

Overrides:

createFilter in class AbstractAuthorizer

Parameters:

principal - the Principal for which to filter

Returns:

a set of entities that the specified user has access to

Throws:

Exception

grant

public void grant(EntityId entity,
         Principal principal,
         Set<Action> actions)

Description copied from interface: PrivilegesManager

Grants a Principal authorization to perform a set of actions on an EntityId.

Parameters:

entity - the EntityId to whom actions are to be granted

principal - the Principal that performs the actions. This could be a user, or role

actions - the set of actions to grant.

revoke

public void revoke(EntityId entity,
          Principal principal,
          Set<Action> actions)

Description copied from interface: PrivilegesManager

Revokes a principal's authorization to perform a set of actions on an EntityId.

Parameters:

entity - the EntityId whose actions are to be revoked

principal - the Principal that performs the actions. This could be a user, group or role

actions - the set of actions to revoke

revoke

public void revoke(EntityId entity)

Description copied from interface: PrivilegesManager

Revokes all principals' authorization to perform any Action on the given EntityId.

Parameters:

entity - the EntityId on which all actions are to be revoked

createRole

public void createRole(Role role)

Description copied from interface: Authorizer

Create a role.

Parameters:

role - the Role to create

dropRole

public void dropRole(Role role)

Description copied from interface: Authorizer

Drop a role.

Parameters:

role - the Role to drop

addRoleToPrincipal

public void addRoleToPrincipal(Role role,
                      Principal principal)

Description copied from interface: Authorizer

Add a role to the specified Principal.

Parameters:

role - the Role to add to the specified group

principal - the Principal to add the role to

removeRoleFromPrincipal

public void removeRoleFromPrincipal(Role role,
                           Principal principal)

Description copied from interface: Authorizer

Delete a role from the specified Principal.

Parameters:

role - the Role to remove from the specified group

principal - the Principal to remove the role from

listRoles

public Set<Role> listRoles(Principal principal)

Description copied from interface: Authorizer

Returns a set of all roles for the specified Principal.

Parameters:

principal - the Principal to look up roles for

Returns:

Set of Role for the specified Principal

listAllRoles

public Set<Role> listAllRoles()

Description copied from interface: Authorizer

Returns all available Role. Only a super user can perform this operation.

Returns:

a set of all available Role in the system.

listPrivileges

public Set<Privilege> listPrivileges(Principal principal)

Description copied from interface: PrivilegesFetcher

Returns all the Privilege for the specified Principal.

Parameters:

principal - the Principal for which to return privileges

Returns:

a Set of Privilege for the specified principal