com.jenjinstudios.io.authentication

Interface Authenticator<T extends ExecutionContext>

public interface Authenticator<T extends ExecutionContext>

Interface defining several methods that are useful for authentication.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PASSWORD This constant is provided an a convenience, to specify a "password" credential in a Map.
static java.lang.String	VERIFICATION_CODE This constant is provided an a convenience, to specify a "verification code" credential in a Map.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(T context, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> credentials) Authenticate the user with the given unique id and valid credentials and, if successful, populating the given ExecutionContext with the user data from the backing data store.
default boolean	authenticate(T context, java.lang.String id, java.lang.String password) Authenticate the user with the given unique id and valid password and, if successful, populating the given ExecutionContext with the user data from the backing data store.
void	close() Close the backing database connection.
boolean	credentialsValid(java.lang.String id, java.util.Map<java.lang.String,java.lang.String> credentials) Determine whether the given credentials are valid for the user with the specified unique identifier.
boolean	isAuthenticated(java.lang.String id) Determine whether the user specified by the given unique identifier is authenticated.
default boolean	passwordValid(java.lang.String id, java.lang.String password) Determine whether the given password is valid.
void	populate(T context, java.lang.String id) Populate the given ExecutionContext with data for the user with the given unique identifier.
boolean	unauthenticate(T context, java.lang.String id) Unauthenticate the user with the given unique id, restoring the given context to an unauthenticated state.
boolean	update(T context, java.lang.String id) Update the backing data store, for the user with the given id, with data from the given context.
boolean	userExists(java.lang.String id) Determine whether the user specified by the given unique identifier exists.

Field Detail

PASSWORD

static final java.lang.String PASSWORD

This constant is provided an a convenience, to specify a "password" credential in a Map.

See Also:

Constant Field Values

VERIFICATION_CODE

static final java.lang.String VERIFICATION_CODE

This constant is provided an a convenience, to specify a "verification code" credential in a Map.

See Also:

Constant Field Values

Method Detail

isAuthenticated

boolean isAuthenticated(java.lang.String id)
                 throws AuthenticationException

Determine whether the user specified by the given unique identifier is authenticated. Behavior when the user doesn't exist is implementation-dependent.

Parameters:

id - The unique user identifier.

Returns:

Whether the user is authenticated.

Throws:

AuthenticationException - If there is an exception when determining authentication status.

userExists

boolean userExists(java.lang.String id)
            throws AuthenticationException

Determine whether the user specified by the given unique identifier exists.

Parameters:

id - The unique identifier of the user.

Returns:

Whether the user with the given identifier exists.

Throws:

AuthenticationException - If there is an exception when determining if the user exists/

credentialsValid

boolean credentialsValid(java.lang.String id,
                         java.util.Map<java.lang.String,java.lang.String> credentials)
                  throws AuthenticationException

Determine whether the given credentials are valid for the user with the specified unique identifier. Behavior when the user doesn't exist is implementation-dependent.

Parameters:

id - The unique user identifier.

credentials - A map of credentials containing key-value pairs, where the key is the name of credential and the value is the plaintext credential. Several constants that may be helpful key choices are provided by this interface.

Returns:

Whether the given credentials are valid.

Throws:

AuthenticationException - If there is an exception when determining the validity of the credentials.

passwordValid

default boolean passwordValid(java.lang.String id,
                              java.lang.String password)
                       throws AuthenticationException

Determine whether the given password is valid. By default, this method assumes that the PASSWORD constant is the key used for storing passwords in the credentials Map.

Parameters:

id - The unique user identifier.

password - The plaintext password.

Returns:

Whether the password is valid.

Throws:

AuthenticationException - If there is an exception when determining password validity.

authenticate

boolean authenticate(T context,
                     java.lang.String id,
                     java.util.Map<java.lang.String,java.lang.String> credentials)
              throws AuthenticationException

Authenticate the user with the given unique id and valid credentials and, if successful, populating the given ExecutionContext with the user data from the backing data store. A suggested method behavior is:

  boolean canLogin =
       this.userExists(id) && !this.isAuthenticated(id) && this.credentialsValid(id,credentials);
   if (canLogin) {
       populate(context, id);
   }
   return canLogin;
 
 

Parameters:

context - The context to be populated with user data if authentication is successful. This object should not be modified if the authentication was unsuccessful.

id - The unique user identifier.

credentials - A map of credentials containing key-value pairs, where the key is the name of credential and the value is the plaintext credential. Several constants that may be helpful key choices are provided by this interface.

Returns:

Whether the user was successfully authenticated. If the user was not successfully authenticated, it is imperative that the context parameter not be modified.

Throws:

AuthenticationException - If there is an exception when authenticating the user.

authenticate

default boolean authenticate(T context,
                             java.lang.String id,
                             java.lang.String password)
                      throws AuthenticationException

Authenticate the user with the given unique id and valid password and, if successful, populating the given ExecutionContext with the user data from the backing data store. By default, this method assumes that the PASSWORD constant is the key used for storing passwords in the credentials Map.

Parameters:

context - The context to be populated with user data if authentication is successful. This object should not be modified if the authentication was unsuccessful.

id - The unique user identifier.

password - The plaintext password.

Returns:

Whether the user was successfully authenticated. If the user was not successfully authenticated, it is imperative that the context parameter not be modified.

Throws:

AuthenticationException - If there is an exception when authenticating the user.

unauthenticate

boolean unauthenticate(T context,
                       java.lang.String id)
                throws AuthenticationException

Unauthenticate the user with the given unique id, restoring the given context to an unauthenticated state.

Parameters:

context - The context for the user to be unauthenticated; should

id - The unique user identifier.

Returns:

Whether the user was successfully unauthenticated and the context was modified.

Throws:

AuthenticationException - If there is an exception during unauthentication.

populate

void populate(T context,
              java.lang.String id)
       throws AuthenticationException

Populate the given ExecutionContext with data for the user with the given unique identifier.

Note: This method should not attempt any sort of authentication; credentials are not provided, it exists for the sole purpose of retrieving and populating user data. For authentication, use the credentialsValid(String, Map), authenticate(ExecutionContext, String, Map), and authenticate(ExecutionContext, String, String) methods.

Parameters:

context - The context to populate with user data.

id - The unique user identifier.

Throws:

AuthenticationException - If there is an exception when populating the user data.

update

boolean update(T context,
               java.lang.String id)
        throws AuthenticationException

Update the backing data store, for the user with the given id, with data from the given context.

Parameters:

context - The context containing data to be placed in the backing data store.

id - The unique user id.

Returns:

true If the update was successful and the backing data store was modified.

Throws:

AuthenticationException - If there is an exception during the update.

close

void close()
    throws AuthenticationException

Close the backing database connection.

Throws:

AuthenticationException - If there is an exception when closing the backing database connection.