org.jboss.security.auth.spi
Class SimpleServerLoginModule

java.lang.Object
  extended by org.jboss.security.auth.spi.AbstractServerLoginModule
      extended by org.jboss.security.auth.spi.UsernamePasswordLoginModule
          extended by org.jboss.security.auth.spi.SimpleServerLoginModule
All Implemented Interfaces:
LoginModule

public class SimpleServerLoginModule
extends UsernamePasswordLoginModule

A simple server login module useful to quick setup of security for testing purposes. It implements the following simple algorithm:

Version:
$Revision: 1.4.26.1 $
Author:
Oleg Nitz, Scott.Stark@jboss.org

Field Summary
 
Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule
callbackHandler, log, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass
 
Constructor Summary
SimpleServerLoginModule()
           
 
Method Summary
protected  Principal getIdentity()
          Overriden by subclasses to return the Principal that corresponds to the user primary identity.
protected  Group[] getRoleSets()
          Overriden by subclasses to return the Groups that correspond to the to the role sets assigned to the user.
protected  String getUsersPassword()
          Get the expected password for the current username available via the getUsername() method.
protected  boolean validatePassword(String inputPassword, String expectedPassword)
          A hook that allows subclasses to change the validation of the input password against the expected password.
 
Methods inherited from class org.jboss.security.auth.spi.UsernamePasswordLoginModule
createPasswordHash, getCredentials, getUnauthenticatedIdentity, getUsername, getUsernameAndPassword, getValidateError, initialize, login, setValidateError
 
Methods inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule
abort, commit, createGroup, createIdentity, getUseFirstPass, logout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleServerLoginModule

public SimpleServerLoginModule()
Method Detail

getIdentity

protected Principal getIdentity()
Description copied from class: AbstractServerLoginModule
Overriden by subclasses to return the Principal that corresponds to the user primary identity.

Overrides:
getIdentity in class UsernamePasswordLoginModule

validatePassword

protected boolean validatePassword(String inputPassword,
                                   String expectedPassword)
Description copied from class: UsernamePasswordLoginModule
A hook that allows subclasses to change the validation of the input password against the expected password. This version checks that neither inputPassword or expectedPassword are null that that inputPassword.equals(expectedPassword) is true;

Overrides:
validatePassword in class UsernamePasswordLoginModule
Returns:
true if the inputPassword is valid, false otherwise.

getRoleSets

protected Group[] getRoleSets()
                       throws LoginException
Description copied from class: AbstractServerLoginModule
Overriden by subclasses to return the Groups that correspond to the to the role sets assigned to the user. Subclasses should create at least a Group named "Roles" that contains the roles assigned to the user. A second common group is "CallerPrincipal" that provides the application identity of the user rather than the security domain identity.

Specified by:
getRoleSets in class AbstractServerLoginModule
Returns:
Group[] containing the sets of roles
Throws:
LoginException

getUsersPassword

protected String getUsersPassword()
                           throws LoginException
Description copied from class: UsernamePasswordLoginModule
Get the expected password for the current username available via the getUsername() method. This is called from within the login() method after the CallbackHandler has returned the username and candidate password.

Specified by:
getUsersPassword in class UsernamePasswordLoginModule
Returns:
the valid password String
Throws:
LoginException


Copyright © 2002 JBoss Group, LLC. All Rights Reserved.