Package org.apache.nifi.authentication

Interface LoginIdentityProvider

public interface LoginIdentityProvider

Identity provider that is able to authentication a user with username/password credentials.

Method Summary

Modifier and Type	Method	Description
AuthenticationResponse	authenticate(LoginCredentials credentials)	Authenticates the specified login credentials.
void	initialize(LoginIdentityProviderInitializationContext initializationContext)	Called immediately after instance creation for implementers to perform additional setup
void	onConfigured(LoginIdentityProviderConfigurationContext configurationContext)	Called to configure the AuthorityProvider.
void	preDestruction()	Called immediately before instance destruction for implementers to release resources.

Method Details

authenticate

AuthenticationResponse authenticate(LoginCredentials credentials)
                             throws InvalidLoginCredentialsException,
IdentityAccessException

Authenticates the specified login credentials.

Parameters:

credentials - the credentials

Returns:

The authentication response

Throws:

InvalidLoginCredentialsException - The login credentials were invalid

IdentityAccessException - Unable to register the user due to an issue accessing the underlying storage

initialize

void initialize(LoginIdentityProviderInitializationContext initializationContext)
         throws ProviderCreationException

Called immediately after instance creation for implementers to perform additional setup

Parameters:

initializationContext - in which to initialize

Throws:

ProviderCreationException - Unable to initialize

onConfigured

void onConfigured(LoginIdentityProviderConfigurationContext configurationContext)
           throws ProviderCreationException

Called to configure the AuthorityProvider.

Parameters:

configurationContext - at the time of configuration

Throws:

ProviderCreationException - for any issues configuring the provider

preDestruction

void preDestruction()
             throws ProviderDestructionException

Called immediately before instance destruction for implementers to release resources.

Throws:

ProviderDestructionException - If pre-destruction fails.