org.jboss.resource.security
Class ConfiguredIdentityLoginModule

java.lang.Object
  extended byorg.jboss.security.auth.spi.AbstractServerLoginModule (src) 
      extended byorg.jboss.resource.security.AbstractPasswordCredentialLoginModule (src) 
          extended byorg.jboss.resource.security.ConfiguredIdentityLoginModule
All Implemented Interfaces:
javax.security.auth.spi.LoginModule

public class ConfiguredIdentityLoginModule
extends AbstractPasswordCredentialLoginModule (src)

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.

See Also:
SimpleGroup (src) , SimplePrincipal (src)

Field Summary
 
Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule (src)
callbackHandler, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass
 
Constructor Summary
ConfiguredIdentityLoginModule()
           
 
Method Summary
protected  java.security.Principal getIdentity()
          Overriden by subclasses to return the Principal that corresponds to the user primary identity.
protected  java.security.acl.Group[] getRoleSets()
          This method simply returns an empty array of Groups which means that no role based permissions are assigned.
 void initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler handler, java.util.Map sharedState, java.util.Map options)
          Initialize the login module.
 boolean login()
          Return false if there is no mcf, else return super.login().
 
Methods inherited from class org.jboss.resource.security.AbstractPasswordCredentialLoginModule (src)
getMcf, getServer, logout, removeCredentials
 
Methods inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule (src)
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(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler handler,
                       java.util.Map sharedState,
                       java.util.Map options)
Description copied from class: AbstractServerLoginModule (src)
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 javax.security.auth.spi.LoginModule
Overrides:
initialize in class AbstractPasswordCredentialLoginModule (src)

login

public boolean login()
              throws javax.security.auth.login.LoginException
Description copied from class: AbstractPasswordCredentialLoginModule (src)
Return false if there is no mcf, else return super.login(). Override to provide custom authentication.

Specified by:
login in interface javax.security.auth.spi.LoginModule
Overrides:
login in class AbstractPasswordCredentialLoginModule (src)
Returns:
false if there is no mcf, else return super.login().
Throws:
javax.security.auth.login.LoginException - if an error occurs

getIdentity

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

Specified by:
getIdentity in class AbstractServerLoginModule (src)

getRoleSets

protected java.security.acl.Group[] getRoleSets()
                                         throws javax.security.auth.login.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 (src)
Returns:
Group[] containing the sets of roles
Throws:
javax.security.auth.login.LoginException