floralvikings / jenjin-io Goto Github PK

connectionBuilder.withContextualTask( (context) -> {
    if(!context.isAuthenticated) {
        authenticator.authenticate(context);
    }
}, (message) -> message instanceof AuthenticationRequest);

public interface Authenticator<T extends ExecutionContext>
{
    /**
     * Authenticate the user with the given credentials, populating the given ExecutionContext
     * IF AND ONLY IF the authentication is successful.
     *
     * @param context The context that will be populated with user data IF the authentication
     * is successful.  If the authentication is not successful, the context should remain 
     * unmodified.
     *
     * @param credentials One or more Strings identifying the user.
     *
     * @return true if the authentication was a success and the context was populated with user
     * data, false if the authentication was a failure and the context was not modified.
     *
     * @throws AuthenticationException If there is an unexpected exception when handling the 
     * authentication.
     */
    bool authenticate(T context, String... credentials) throws AuthenticationException;

    /**
     * Deauthenticate the user with the given credentials, depopulating the given 
     * ExecutionContext IF AND ONLY IF the authentication is successful.
     *
     * @param context The context that will be depopulated with user data IF the 
     * deauthentication is successful.  If the deauthentication is not successful,
     * the context should remain unmodified.  
     * (Maybe not, just a rough draft)
     *
     * @param credentials One or more Strings identifying the user.
     *
     * @throws AuthenticationException If there is an unexpected exception when handling the 
     * authentication.
     */
    void deauthenticate(T context, String... credentials) throws AuthenticationException;

    /**
     * Update the user with the given credentials from the given 
     * ExecutionContext.
     *
     * @param context The context that will be used to update user data.  
     * The context should remain unmodified.
     *
     * @param credentials One or more Strings identifying the user.
     *
     * @throws AuthenticationException If there is an unexpected exception when handling the 
     * update.
     */
    void update(T context, String... credentials) throws AuthenticationException;
}