Package com.sun.enterprise.security.auth.login

Class ClientPasswordLoginModule

java.lang.Object

com.sun.enterprise.security.auth.login.ClientPasswordLoginModule

All Implemented Interfaces:

LoginModule

public class ClientPasswordLoginModule
extends Object
implements LoginModule

This sample LoginModule authenticates users with a password.

If testUser successfully authenticates itself, a UserPrincipal with the testUser's username is added to the Subject.

Author:

Harpreet Singh ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOGIN_NAME
static final String	LOGIN_PASSWORD

Constructor Summary

Constructors

Constructor	Description
ClientPasswordLoginModule()

Method Summary

Modifier and Type	Method	Description
boolean	abort()	This method is called if the LoginContext's overall authentication failed.
boolean	commit()	This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)	Initialize this LoginModule.
boolean	login()	Authenticate the user by prompting for a username and password.
boolean	logout()	Logout the user.

Methods inherited from class java.lang.Object

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

Field Details

LOGIN_NAME

public static final String LOGIN_NAME

See Also:

• Constant Field Values

LOGIN_PASSWORD

public static final String LOGIN_PASSWORD

See Also:

• Constant Field Values

Constructor Details

ClientPasswordLoginModule

public ClientPasswordLoginModule()

Method Details

initialize

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

Initialize this LoginModule.

Specified by:

initialize in interface LoginModule

Parameters:

subject - the Subject to be authenticated.

callbackHandler - a CallbackHandler for communicating with the end user (prompting for usernames and passwords, for example).

sharedState - shared LoginModule state.

options - options specified in the login Configuration for this particular LoginModule.

login

public boolean login()
              throws LoginException

Authenticate the user by prompting for a username and password.

Specified by:

login in interface LoginModule

Returns:

true in all cases since this LoginModule should not be ignored.

Throws:

FailedLoginException - if the authentication fails.

LoginException - if this LoginModule is unable to perform the authentication.

commit

public boolean commit()
               throws LoginException

This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates a UserPrincipal with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes any state that was originally saved.

Specified by:

commit in interface LoginModule

Returns:

true if this LoginModule's own login and commit attempts succeeded, or false otherwise.

Throws:

LoginException - if the commit fails.

abort

public boolean abort()
              throws LoginException

This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login and commit methods), then this method cleans up any state that was originally saved.

Specified by:

abort in interface LoginModule

Returns:

false if this LoginModule's own login and/or commit attempts failed, and true otherwise.

Throws:

LoginException - if the abort fails.

logout

public boolean logout()
               throws LoginException

Logout the user.

This method removes the UserPrincipal that was added by the commit method.

Specified by:

logout in interface LoginModule

Returns:

true in all cases since this LoginModule should not be ignored.

Throws:

LoginException - if the logout fails.