org.jboss.resource.security
Class ConfiguredIdentityLoginModule

java.lang.Object
  org.jboss.security.auth.spi.AbstractServerLoginModule
      org.jboss.resource.security.AbstractPasswordCredentialLoginModule
          org.jboss.resource.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: 1.10.2.2 $

Author:

Scott.Stark@jboss.org, David Jencks

See Also:

SimpleGroup, SimplePrincipal

Field Summary

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

callbackHandler, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass

Constructor Summary

ConfiguredIdentityLoginModule()

Method Summary

protected Principal	getIdentity()
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 sharedState, Map options)
boolean	login() Return false if there is no mcf, else return super.login().

Methods inherited from class org.jboss.resource.security.AbstractPasswordCredentialLoginModule

getMcf, getServer, logout, removeCredentials

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

abort, commit, createGroup, createIdentity, 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 sharedState,
                       Map options)

Specified by:

initialize in interface LoginModule

Overrides:

initialize in class AbstractPasswordCredentialLoginModule

login

public boolean login()
              throws LoginException

Description copied from class: AbstractPasswordCredentialLoginModule

Return false if there is no mcf, else return super.login(). Override to provide custom authentication.

Specified by:

login in interface LoginModule

Overrides:

login in class AbstractPasswordCredentialLoginModule

Returns:

false if there is no mcf, else return super.login().

Throws:

LoginException - if an error occurs

getIdentity

protected Principal getIdentity()

Specified by:

getIdentity in class org.jboss.security.auth.spi.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 org.jboss.security.auth.spi.AbstractServerLoginModule

Throws:

LoginException