alluxio.security.login

Class AppLoginModule

java.lang.Object

alluxio.security.login.AppLoginModule

All Implemented Interfaces:

LoginModule

@NotThreadSafe
public final class AppLoginModule
extends Object
implements LoginModule

An app login module that creates a user based on the user name provided through application configuration. Specifically, through Alluxio property alluxio.security.login.username. This module is useful if multiple Alluxio clients running under same OS user name want to get different identifies (for resource and data management), or if Alluxio clients running under different OS user names want to get same identify.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppLoginModule.AppCallbackHandler A callback handler for AppLoginModule.

Constructor Summary

Constructors

Constructor and Description
AppLoginModule() Constructs a new AppLoginModule.

Method Summary

Modifier and Type	Method and Description
boolean	abort() Aborts the authentication (second phase).
boolean	commit() Commits the authentication (second phase).
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
boolean	login() Retrieves the user name by querying the property of PropertyKey.SECURITY_LOGIN_USERNAME through AppLoginModule.AppCallbackHandler.
boolean	logout() Logs out the user

Methods inherited from class java.lang.Object

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

Constructor Detail

AppLoginModule

public AppLoginModule()

Constructs a new AppLoginModule.

Method Detail

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map<String,?> sharedState,
                       Map<String,?> options)

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

Retrieves the user name by querying the property of PropertyKey.SECURITY_LOGIN_USERNAME through AppLoginModule.AppCallbackHandler.

Specified by:

login in interface LoginModule

Returns:

true if user name provided by application is set and not empty

Throws:

LoginException - when the login fails

abort

public boolean abort()
              throws LoginException

Aborts the authentication (second phase).

This method is called if the LoginContext's overall authentication failed. (login failed) It cleans up any state that was changed in the login and commit methods.

Specified by:

abort in interface LoginModule

Returns:

true in all cases

Throws:

LoginException - when the abortion fails

commit

public boolean commit()
               throws LoginException

Commits the authentication (second phase).

This method is called if the LoginContext's overall authentication succeeded. The implementation first checks if there is already Alluxio user in the subject. If not, it adds the previously logged in Alluxio user into the subject.

Specified by:

commit in interface LoginModule

Returns:

true if an Alluxio user is found or created

Throws:

LoginException - not Alluxio user is found or created

logout

public boolean logout()
               throws LoginException

Logs out the user

The implementation removes the User associated with the Subject.

Specified by:

logout in interface LoginModule

Returns:

true in all cases

Throws:

LoginException - if logout fails