|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.security.auth.spi.AbstractServerLoginModule
org.jboss.security.auth.spi.IdentityLoginModule
public class IdentityLoginModule
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.
SimpleGroup
,
SimplePrincipal
Field Summary |
---|
Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule |
---|
callbackHandler, log, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass |
Constructor Summary | |
---|---|
IdentityLoginModule()
|
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. |
void |
initialize(Subject subject,
CallbackHandler handler,
Map sharedState,
Map 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.jboss.security.auth.spi.AbstractServerLoginModule |
---|
abort, commit, createGroup, createIdentity, getUnauthenticatedIdentity, getUseFirstPass, logout |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IdentityLoginModule()
Method Detail |
---|
public void initialize(Subject subject, CallbackHandler handler, Map sharedState, Map options)
AbstractServerLoginModule
option: password-stacking: If this is set to "useFirstPass", the login
identity will be taken from the javax.security.auth.login.name
value of the sharedState map, and the proof of identity from the
javax.security.auth.login.password
value of the sharedState
map.
option: principalClass: A Principal implementation that support a ctor
taking a String argument for the princpal name.
option: unauthenticatedIdentity: the name of the principal to asssign
and authenticate when a null username and password are seen.
initialize
in interface LoginModule
initialize
in class AbstractServerLoginModule
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 instancesoptions
- the parameters passed to the login module.public boolean login() throws LoginException
AbstractServerLoginModule
login
in interface LoginModule
login
in class AbstractServerLoginModule
LoginException
protected Principal getIdentity()
AbstractServerLoginModule
getIdentity
in class AbstractServerLoginModule
protected Group[] getRoleSets() throws LoginException
AbstractServerLoginModule
getRoleSets
in class AbstractServerLoginModule
LoginException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |