net.codescore.security
Class CSLoginModule

java.lang.Object
  extended by net.codescore.security.CSLoginModule
All Implemented Interfaces:
LoginModule

public class CSLoginModule
extends Object
implements LoginModule

Author:
Adam Cornett

Field Summary
private  CallbackHandler callbackHandler
           
private  boolean commitSucceeded
           
(package private)  DataContext dc
           
private  org.apache.commons.logging.Log log
           
private  char[] password
           
private  Subject subject
           
private  boolean succeeded
           
private  String username
           
private  CSUserPrincipal userPrincipal
           
 
Constructor Summary
CSLoginModule()
           
 
Method Summary
 boolean abort()
           This method is called if the LoginContext's overall authentication failed.
private  boolean checkLogin(String uname, String pass)
           
 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 sharedState, Map options)
          Initialize this LoginModule.
 boolean login()
          Authenticate the user by prompting for a user name 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 Detail

callbackHandler

private CallbackHandler callbackHandler

commitSucceeded

private boolean commitSucceeded

log

private org.apache.commons.logging.Log log

password

private char[] password

subject

private Subject subject

succeeded

private boolean succeeded

username

private String username

userPrincipal

private CSUserPrincipal userPrincipal

dc

DataContext dc
Constructor Detail

CSLoginModule

public CSLoginModule()
Method Detail

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.

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 Principal 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.

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map 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.

logout

public boolean logout()
               throws LoginException
Logout the user.

This method removes the Principal 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.

checkLogin

private boolean checkLogin(String uname,
                           String pass)


Copyright 2008 © Adam Cornett, Andrew Conner All Rights Reserved.