org.apache.catalina.realm
public class JAASMemoryLoginModule extends MemoryRealm implements javax.security.auth.spi.LoginModule, Realm
Implementation of the JAAS LoginModule interface,
primarily for use in testing JAASRealm. It utilizes an
XML-format data file of username/password/role information identical to
that supported by org.apache.catalina.realm.MemoryRealm
(except that digested passwords are not supported).
This class recognizes the following string-valued options, which are
specified in the configuration file (and passed to our constructor in
the options argument:
false.MemoryRealm. The default value matches the MemoryRealm
default.IMPLEMENTATION NOTE - This class implements
Realm only to satisfy the calling requirements of the
GenericPrincipal constructor. It does not actually perform
the functionality required of a Realm implementation.
RealmBase.AllRolesMode| Modifier and Type | Field and Description |
|---|---|
protected javax.security.auth.callback.CallbackHandler |
callbackHandler
The callback handler responsible for answering our requests.
|
protected boolean |
committed
Has our own
commit() returned successfully? |
protected java.util.Map |
options
The configuration information for this
LoginModule. |
protected java.lang.String |
pathname
The absolute or relative pathname to the XML configuration file.
|
protected java.security.Principal |
principal
The
Principal identified by our validation, or
null if validation falied. |
protected java.util.HashMap |
principals
The set of
Principals loaded from our configuration file. |
protected java.util.Map |
sharedState
The state information that is shared with other configured
LoginModule instances. |
protected static StringManager |
sm
The string manager for this package.
|
protected javax.security.auth.Subject |
subject
The subject for which we are performing authentication.
|
info, nameallRolesMode, container, containerLog, controller, digest, digestEncoding, domain, host, initialized, lifecycle, md, md5Encoder, md5Helper, mserver, oname, path, realmPath, started, support, type, validateAFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT| Constructor and Description |
|---|
JAASMemoryLoginModule() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
abort()
Phase 2 of authenticating a
Subject when Phase 1
fails. |
boolean |
commit()
Phase 2 of authenticating a
Subject when Phase 1
was successful. |
SecurityConstraint[] |
findSecurityConstraints(Request request,
Context context)
Return the SecurityConstraints configured to guard the request URI for
this request, or
null if there is no such constraint. |
void |
initialize(javax.security.auth.Subject subject,
javax.security.auth.callback.CallbackHandler callbackHandler,
java.util.Map sharedState,
java.util.Map options)
Initialize this
LoginModule with the specified
configuration information. |
protected void |
load()
Load the contents of our configuration file.
|
boolean |
login()
Phase 1 of authenticating a
Subject. |
boolean |
logout()
Log out this user.
|
authenticate, getDigester, getInfo, getName, getPassword, getPathname, getPrincipal, getPrincipals, setPathname, start, stopaddLifecycleListener, addPropertyChangeListener, authenticate, authenticate, authenticate, backgroundProcess, destroy, digest, Digest, findLifecycleListeners, getAllRolesMode, getContainer, getController, getDigest, getDigest, getDigestEncoding, getDomain, getObjectName, getPrincipal, getRealmPath, getRealmSuffix, getType, getValidate, hasMessageDigest, hasResourcePermission, hasRole, hasUserDataPermission, init, main, postDeregister, postRegister, preDeregister, preRegister, removeLifecycleListener, removePropertyChangeListener, setAllRolesMode, setContainer, setController, setDigest, setDigestEncoding, setRealmPath, setValidateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, backgroundProcess, getContainer, getInfo, hasResourcePermission, hasRole, hasUserDataPermission, removePropertyChangeListener, setContainerprotected javax.security.auth.callback.CallbackHandler callbackHandler
protected boolean committed
commit() returned successfully?protected java.util.Map options
LoginModule.protected java.lang.String pathname
protected java.security.Principal principal
Principal identified by our validation, or
null if validation falied.protected java.util.HashMap principals
Principals loaded from our configuration file.protected static StringManager sm
protected java.util.Map sharedState
LoginModule instances.protected javax.security.auth.Subject subject
public boolean abort()
throws javax.security.auth.login.LoginException
Subject when Phase 1
fails. This method is called if the LoginContext
failed somewhere in the overall authentication chain.abort in interface javax.security.auth.spi.LoginModuletrue if this method succeeded, or
false if this LoginModule should be
ignoredjavax.security.auth.login.LoginException - if the abort failspublic boolean commit()
throws javax.security.auth.login.LoginException
Subject when Phase 1
was successful. This method is called if the LoginContext
succeeded in the overall authentication chain.commit in interface javax.security.auth.spi.LoginModuletrue if the authentication succeeded, or
false if this LoginModule should be
ignoredjavax.security.auth.login.LoginException - if the commit failspublic SecurityConstraint[] findSecurityConstraints(Request request, Context context)
null if there is no such constraint.findSecurityConstraints in interface RealmfindSecurityConstraints in class RealmBaserequest - Request we are processingcontext - Context the Request is mapped topublic void initialize(javax.security.auth.Subject subject,
javax.security.auth.callback.CallbackHandler callbackHandler,
java.util.Map sharedState,
java.util.Map options)
LoginModule with the specified
configuration information.initialize in interface javax.security.auth.spi.LoginModulesubject - The Subject to be authenticatedcallbackHandler - A CallbackHandler for communicating
with the end user as necessarysharedState - State information shared with other
LoginModule instancesoptions - Configuration information for this specific
LoginModule instancepublic boolean login()
throws javax.security.auth.login.LoginException
Subject.login in interface javax.security.auth.spi.LoginModuletrue if the authentication succeeded, or
false if this LoginModule should be
ignoredjavax.security.auth.login.LoginException - if the authentication failspublic boolean logout()
throws javax.security.auth.login.LoginException
logout in interface javax.security.auth.spi.LoginModuletrue in all cases because thie
LoginModule should not be ignoredjavax.security.auth.login.LoginException - if logging out failedprotected void load()
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.