Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members | Related Pages

org.colimas.security.LoginModule Class Reference

List of all members.

Public Member Functions

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

Detailed Description

ColimasLoginModule.java

Function:
Module file: ColimasLogin { org.colimas.security.LoginModule required debug=true; };

Author:
zhao lei
Version:
1.0
Modification History:
 SEQ DATE       ORDER DEVELOPER      DESCRIPTION
 --- ---------- ----- -------------- -----------------------------
 001 2005/12/03          zhao lei       INIT
 


Member Function Documentation

boolean org.colimas.security.LoginModule.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.

Exceptions:
LoginException if the abort fails.
Returns:
false if this LoginModule's own login and/or commit attempts failed, and true otherwise.

boolean org.colimas.security.LoginModule.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 the relevant PrincipalExamples 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.

Exceptions:
LoginException if the commit fails.
Returns:
true if this LoginModule's own login and commit attempts succeeded, or false otherwise.

void org.colimas.security.LoginModule.initialize Subject  subject,
CallbackHandler  callbackHandler,
Map  sharedState,
Map  options
 

Initializes the LoginModule.

Parameters:
subject the Subject to be authenticated.
callbackHandler a CallbackHandler for prompting and retrieving the userid and password from the user.
sharedState shared LoginModule state.
options options specified in the login configuration file for this LoginModule.

boolean org.colimas.security.LoginModule.login  )  throws LoginException
 

Prompts the user for a userid and password.

Returns:
true if the authentication succeeded, or false if this LoginModule should be ignored
Exceptions:
FailedLoginException if the authentication fails.
LoginException if the LoginModule is unable to authenticate.

boolean org.colimas.security.LoginModule.logout  )  throws LoginException
 

Logouts a Subject.

This method removes the PrincipalExample instances that were added by the commit method.

Exceptions:
LoginException if the logout fails.
Returns:
true if this method succeeded, or false if this LoginModule should be ignored.


The documentation for this class was generated from the following file:
Generated on Sat Jan 14 02:04:31 2006 for Colimas by  doxygen 1.4.4