public class UserDatabaseRealm extends RealmBase
Implementation of Realm
that is based on an implementation of
UserDatabase
made available through the global JNDI resources
configured for this instance of Catalina. Set the resourceName
parameter to the global JNDI resources name for the configured instance
of UserDatabase
that we should consult.
RealmBase.AllRolesMode
Lifecycle.SingleUse
Modifier and Type | Field and Description |
---|---|
protected UserDatabase |
database
The
UserDatabase we will use to authenticate users
and identify associated roles. |
protected static java.lang.String |
name
Descriptive information about this Realm implementation.
|
protected java.lang.String |
resourceName
The global JNDI name of the
UserDatabase resource
we will be utilizing. |
allRolesMode, container, containerLog, digest, digestEncoding, md, md5Helper, realmPath, sm, stripRealmForGss, support, validate, x509UsernameRetriever, x509UsernameRetrieverClassName
mserver
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
UserDatabaseRealm() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
getName()
Return a short name for this Realm implementation.
|
protected java.lang.String |
getPassword(java.lang.String username)
Return the password associated with the given principal's user name.
|
protected java.security.Principal |
getPrincipal(java.lang.String username)
Return the Principal associated with the given user name.
|
java.lang.String |
getResourceName() |
boolean |
hasRole(Wrapper wrapper,
java.security.Principal principal,
java.lang.String role)
Return
true if the specified Principal has the specified
security role, within the context of this Realm; otherwise return
false . |
void |
setResourceName(java.lang.String resourceName)
Set the global JNDI name of the
UserDatabase resource
we will be using. |
protected void |
startInternal()
Prepare for the beginning of active use of the public methods of this
component and implement the requirements of
LifecycleBase.startInternal() . |
protected void |
stopInternal()
Gracefully terminate the active use of the public methods of this
component and implement the requirements of
LifecycleBase.stopInternal() . |
addPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, authenticate, backgroundProcess, compareCredentials, digest, Digest, findSecurityConstraints, getAllRolesMode, getContainer, getCredentialHandler, getDigest, getDigest, getDigestCharset, getDigestEncoding, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getPrincipal, getRealmPath, getRealmSuffix, getServer, getTransportGuaranteeRedirectStatus, getValidate, getX509UsernameRetrieverClassName, hasMessageDigest, hasResourcePermission, hasUserDataPermission, initInternal, isStripRealmForGss, main, removePropertyChangeListener, setAllRolesMode, setContainer, setCredentialHandler, setDigest, setDigestEncoding, setRealmPath, setStripRealmForGss, setTransportGuaranteeRedirectStatus, setValidate, setX509UsernameRetrieverClassName, toString
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop
protected UserDatabase database
UserDatabase
we will use to authenticate users
and identify associated roles.protected static final java.lang.String name
protected java.lang.String resourceName
UserDatabase
resource
we will be utilizing.public java.lang.String getResourceName()
UserDatabase
resource
we will be using.public void setResourceName(java.lang.String resourceName)
UserDatabase
resource
we will be using.resourceName
- The new global JNDI namepublic boolean hasRole(Wrapper wrapper, java.security.Principal principal, java.lang.String role)
true
if the specified Principal has the specified
security role, within the context of this Realm; otherwise return
false
. This implementation returns true
if the User
has the role, or if any Group
that the User
is a member of has the role.hasRole
in interface Realm
hasRole
in class RealmBase
principal
- Principal for whom the role is to be checkedrole
- Security role to be checkedwrapper
- wrapper context for evaluating roletrue
if the specified Principal has the specified
security role, within the context of this Realm; otherwise return
false
.protected java.lang.String getName()
protected java.lang.String getPassword(java.lang.String username)
getPassword
in class RealmBase
username
- The user nameprotected java.security.Principal getPrincipal(java.lang.String username)
getPrincipal
in class RealmBase
username
- The user nameprotected void startInternal() throws LifecycleException
LifecycleBase.startInternal()
.startInternal
in class RealmBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedprotected void stopInternal() throws LifecycleException
LifecycleBase.stopInternal()
.stopInternal
in class RealmBase
LifecycleException
- if this component detects a fatal error
that needs to be reportedCopyright © 2000-2018 Apache Software Foundation. All Rights Reserved.