org.picketbox.datasource.security

Class ConfiguredIdentityLoginModule

java.lang.Object

org.jboss.security.auth.spi.AbstractServerLoginModule

org.picketbox.datasource.security.AbstractPasswordCredentialLoginModule

org.picketbox.datasource.security.ConfiguredIdentityLoginModule

All Implemented Interfaces:

LoginModule

public class ConfiguredIdentityLoginModule
extends AbstractPasswordCredentialLoginModule

A simple login module that simply associates the principal specified in the module options with any subject authenticated against the module. The type of Principal class used is org.jboss.security.SimplePrincipal.

If no principal option is specified a principal with the name of 'guest' is used.

Version:

$Revision: 71545 $

Author:

Scott.Stark@jboss.org, David Jencks

See Also:

SimpleGroup, SimplePrincipal

Field Summary

Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule

callbackHandler, jbossModuleName, log, loginOk, options, principalClassModuleName, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass

Constructor Summary

Constructors

Constructor and Description
ConfiguredIdentityLoginModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected Principal	getIdentity() Overriden by subclasses to return the Principal that corresponds to the user primary identity.
protected Group[]	getRoleSets() This method simply returns an empty array of Groups which means that no role based permissions are assigned.
void	initialize(Subject subject, CallbackHandler handler, Map<String,?> sharedState, Map<String,?> options) Initialize the login module.
boolean	login() Looks for javax.security.auth.login.name and javax.security.auth.login.password values in the sharedState map if the useFirstPass option was true and returns true if they exist.

Methods inherited from class org.picketbox.datasource.security.AbstractPasswordCredentialLoginModule

logout, removeCredentials

Methods inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule

abort, addValidOptions, checkOptions, commit, createGroup, createIdentity, getCallerPrincipalGroup, getUnauthenticatedIdentity, getUseFirstPass

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredIdentityLoginModule

public ConfiguredIdentityLoginModule()

Method Detail

initialize

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

Description copied from class: AbstractServerLoginModule

Initialize the login module. This stores the subject, callbackHandler and sharedState and options for the login session. Subclasses should override if they need to process their own options. A call to super.initialize(...) must be made in the case of an override.

Specified by:

initialize in interface LoginModule

Overrides:

initialize in class AbstractServerLoginModule

Parameters:

subject - the Subject to update after a successful login.

handler - the CallbackHandler that will be used to obtain the the user identity and credentials.

sharedState - a Map shared between all configured login module instances

options - the parameters passed to the login module.

login

public boolean login()
              throws LoginException

Description copied from class: AbstractServerLoginModule

Looks for javax.security.auth.login.name and javax.security.auth.login.password values in the sharedState map if the useFirstPass option was true and returns true if they exist. If they do not or are null this method returns false. Note that subclasses that override the login method must set the loginOk ivar to true if the login succeeds in order for the commit phase to populate the Subject. This implementation sets loginOk to true if the login() method returns true, otherwise, it sets loginOk to false.

Specified by:

login in interface LoginModule

Overrides:

login in class AbstractServerLoginModule

Throws:

LoginException

getIdentity

protected Principal getIdentity()

Description copied from class: AbstractServerLoginModule

Overriden by subclasses to return the Principal that corresponds to the user primary identity.

Specified by:

getIdentity in class AbstractServerLoginModule

getRoleSets

protected Group[] getRoleSets()
                       throws LoginException

This method simply returns an empty array of Groups which means that no role based permissions are assigned.

Specified by:

getRoleSets in class AbstractServerLoginModule

Returns:

Group[] containing the sets of roles

Throws:

LoginException