org.apache.catalina.realm
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
Modifier and Type | Field and Description |
---|---|
protected UserDatabase |
database
The
UserDatabase we will use to authenticate users
and identify associated roles. |
protected java.lang.String |
info
Descriptive information about this Realm implementation.
|
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, controller, digest, digestEncoding, domain, host, initialized, lifecycle, md, md5Encoder, md5Helper, mserver, oname, path, realmPath, started, support, type, validate
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
UserDatabaseRealm() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getInfo()
Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version> . |
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()
Return the global JNDI name of the
UserDatabase resource
we will be using. |
boolean |
hasRole(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. |
void |
start()
Prepare for active use of the public methods of this Component.
|
void |
stop()
Gracefully shut down active use of the public methods of this Component.
|
addLifecycleListener, addPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, backgroundProcess, destroy, digest, Digest, findLifecycleListeners, findSecurityConstraints, getAllRolesMode, getContainer, getController, getDigest, getDigest, getDigestEncoding, getDomain, getObjectName, getPrincipal, getRealmPath, getRealmSuffix, getType, getValidate, hasMessageDigest, hasResourcePermission, hasUserDataPermission, init, main, postDeregister, postRegister, preDeregister, preRegister, removeLifecycleListener, removePropertyChangeListener, setAllRolesMode, setContainer, setController, setDigest, setDigestEncoding, setRealmPath, setValidate
protected UserDatabase database
UserDatabase
we will use to authenticate users
and identify associated roles.protected final java.lang.String info
protected static final java.lang.String name
protected java.lang.String resourceName
UserDatabase
resource
we will be utilizing.public java.lang.String getInfo()
<description>/<version>
.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(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.protected java.lang.String getName()
protected java.lang.String getPassword(java.lang.String username)
getPassword
in class RealmBase
protected java.security.Principal getPrincipal(java.lang.String username)
getPrincipal
in class RealmBase
public void start() throws LifecycleException
start
in interface Lifecycle
start
in class RealmBase
LifecycleException
- if this component detects a fatal error
that prevents it from being startedpublic void stop() throws LifecycleException
stop
in interface Lifecycle
stop
in class RealmBase
LifecycleException
- if this component detects a fatal error
that needs to be reportedCopyright © 2000-2014 Apache Software Foundation. All Rights Reserved.