org.jboss.security.auth.spi
Class IdentityLoginModule

java.lang.Object
  org.jboss.security.auth.spi.AbstractServerLoginModule (src) 
      org.jboss.security.auth.spi.IdentityLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

public class IdentityLoginModule

extends AbstractServerLoginModule (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)

IdentityLoginModule

public IdentityLoginModule()

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 AbstractServerLoginModule (src)

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 javax.security.auth.login.LoginException

Description copied from class: AbstractServerLoginModule (src)

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 javax.security.auth.spi.LoginModule

Overrides:

login in class AbstractServerLoginModule (src)

Throws:

javax.security.auth.login.LoginException

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

Description copied from class: AbstractServerLoginModule (src)

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 (src)

Returns:

Group[] containing the sets of roles

Throws:

javax.security.auth.login.LoginException