de.ipk_gatersleben.bit.bi.edal.sample.login

Class UserLoginModule

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.sample.login.UserLoginModule

All Implemented Interfaces:

LoginModule

public class UserLoginModule
extends Object
implements LoginModule

This sample LoginModule authenticates users with a password. This LoginModule only recognizes one user: testUser testUser's password is: testPassword If testUser successfully authenticates itself, a SamplePrincipal with the testUser's user name is added to the Subject. This LoginModule recognizes the debug option. If set to true in the login Configuration, debug messages will be output to the output stream, System.out.

Version:

1.18, 01/11/00

Author:

arendd (Modified by arendd)

Constructor Summary

Constructors

Constructor and Description
UserLoginModule()

Method Summary

Methods

Modifier and Type	Method and 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).
Map<String,?>	getOptions()
Map<String,?>	getSharedState()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options) Initialize this LoginModule.
boolean	login() Authenticate the user by prompting for a user name and password.
boolean	logout() Logout the user.
void	setOptions(Map<String,?> options)
void	setSharedState(Map<String,?> sharedState)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserLoginModule

public UserLoginModule()

Method Detail

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 user names 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 user name 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 SamplePrincipal 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 SamplePrincipal 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.

getSharedState

public Map<String,?> getSharedState()

Returns:

the sharedState

setSharedState

public void setSharedState(Map<String,?> sharedState)

Parameters:

sharedState - the sharedState to set

getOptions

public Map<String,?> getOptions()

Returns:

the options

setOptions

public void setOptions(Map<String,?> options)

Parameters:

options - the options to set