Package org.apache.nifi.authorization

Interface UserGroupProvider

All Known Subinterfaces:

ConfigurableUserGroupProvider

public interface UserGroupProvider

Provides access to Users and Groups. NOTE: Extensions will be called often and frequently. Because of this, if the underlying implementation needs to make remote calls or expensive calculations those should probably be done asynchronously and/or cache the results. Additionally, extensions need to be thread safe.

Method Summary

Modifier and Type	Method	Description
Group	getGroup(String identifier)	Retrieves a Group by id.
default Group	getGroupByName(String name)	Retrieves a Group by name.
Set<Group>	getGroups()	Retrieves all groups.
User	getUser(String identifier)	Retrieves the user with the given identifier.
UserAndGroups	getUserAndGroups(String identity)	Gets a user and their groups.
User	getUserByIdentity(String identity)	Retrieves the user with the given identity.
Set<User>	getUsers()	Retrieves all users.
void	initialize(UserGroupProviderInitializationContext initializationContext)	Called immediately after instance creation for implementers to perform additional setup
void	onConfigured(AuthorizerConfigurationContext configurationContext)	Called to configure the Authorizer.
void	preDestruction()	Called immediately before instance destruction for implementers to release resources.

Method Details

getUsers

Set<User> getUsers()
            throws AuthorizationAccessException

Retrieves all users. Must be non null

Returns:

a list of users

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getUser

User getUser(String identifier)
      throws AuthorizationAccessException

Retrieves the user with the given identifier.

Parameters:

identifier - the id of the user to retrieve

Returns:

the user with the given id, or null if no matching user was found

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getUserByIdentity

User getUserByIdentity(String identity)
                throws AuthorizationAccessException

Retrieves the user with the given identity.

Parameters:

identity - the identity of the user to retrieve

Returns:

the user with the given identity, or null if no matching user was found

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getGroups

Set<Group> getGroups()
              throws AuthorizationAccessException

Retrieves all groups. Must be non null

Returns:

a list of groups

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getGroup

Group getGroup(String identifier)
        throws AuthorizationAccessException

Retrieves a Group by id.

Parameters:

identifier - the identifier of the Group to retrieve

Returns:

the Group with the given identifier, or null if no matching group was found

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getGroupByName

default Group getGroupByName(String name)
                      throws AuthorizationAccessException

Retrieves a Group by name.

Parameters:

name - the name of the group to retrieve

Returns:

the Group with the given name, or null if no matching group was found

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

getUserAndGroups

UserAndGroups getUserAndGroups(String identity)
                        throws AuthorizationAccessException

Gets a user and their groups. Must be non null. If the user is not known the UserAndGroups.getUser() and UserAndGroups.getGroups() should return null

Returns:

the UserAndGroups for the specified identity

Throws:

AuthorizationAccessException - if there was an unexpected error performing the operation

initialize

void initialize(UserGroupProviderInitializationContext initializationContext)
         throws AuthorizerCreationException

Called immediately after instance creation for implementers to perform additional setup

Parameters:

initializationContext - in which to initialize

Throws:

AuthorizerCreationException

onConfigured

void onConfigured(AuthorizerConfigurationContext configurationContext)
           throws AuthorizerCreationException

Called to configure the Authorizer.

Parameters:

configurationContext - at the time of configuration

Throws:

AuthorizerCreationException - for any issues configuring the provider

preDestruction

void preDestruction()
             throws AuthorizerDestructionException

Called immediately before instance destruction for implementers to release resources.

Throws:

AuthorizerDestructionException - If pre-destruction fails.