alluxio.security.login

Class AlluxioLoginModule

java.lang.Object

alluxio.security.login.AlluxioLoginModule

All Implemented Interfaces:

LoginModule

@NotThreadSafe
public final class AlluxioLoginModule
extends Object
implements LoginModule

A login module that search the Kerberos or OS user from Subject, and then convert to an Alluxio user. It does not really authenticate the user in its login method.

Constructor Summary

Constructors

Constructor and Description
AlluxioLoginModule() Constructs a new AlluxioLoginModule.

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() Authenticates the user (first phase).
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

AlluxioLoginModule

public AlluxioLoginModule()

Constructs a new AlluxioLoginModule.

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

Authenticates the user (first phase). The implementation does not really authenticate the user here. Always return true.

Specified by:

login in interface LoginModule

Returns:

true in all cases

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. (login succeeded) The implementation searches the Kerberos or OS user in the Subject. If existed, convert it to an Alluxio user and add into the Subject.

Specified by:

commit in interface LoginModule

Returns:

true in all cases

Throws:

LoginException - if the user extending a specific Principal is not found

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