org.apache.geronimo.security.realm.providers
Class NamedUsernamePasswordCredentialLoginModule

java.lang.Object
  org.apache.geronimo.security.realm.providers.NamedUsernamePasswordCredentialLoginModule

All Implemented Interfaces:

LoginModule

public class NamedUsernamePasswordCredentialLoginModule
extends Object
implements LoginModule

Inserts named Username/Password credential into private credentials of Subject.

If either the username or password is not passed in the callback handler, then the credential is not placed into the Subject. This login module does not check credentials so it should never be able to cause a login to succeed. Therefore the lifecycle methods must return false to indicate success or throw a LoginException to indicate failure.

Field Summary

static String	CREDENTIAL_NAME
static String	CREDENTIAL_NAME_LONG
static List<String>	supportedOptions

Constructor Summary

NamedUsernamePasswordCredentialLoginModule()

Method Summary

boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login()
boolean	logout()

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIAL_NAME

public static final String CREDENTIAL_NAME

See Also:

Constant Field Values

CREDENTIAL_NAME_LONG

public static final String CREDENTIAL_NAME_LONG

supportedOptions

public static final List<String> supportedOptions

Constructor Detail

NamedUsernamePasswordCredentialLoginModule

public NamedUsernamePasswordCredentialLoginModule()

Method Detail

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map options)

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException