|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.catalina.realm.RealmBase org.apache.catalina.realm.UserDatabaseRealm
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.
Field Summary | |
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. |
Fields inherited from class org.apache.catalina.realm.RealmBase |
container, debug, digest, lifecycle, md, md5Encoder, md5Helper, started, support, validate |
Fields inherited from interface org.apache.catalina.Lifecycle |
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT |
Constructor Summary | |
UserDatabaseRealm()
|
Method Summary | |
java.security.Principal |
authenticate(java.lang.String username,
java.lang.String credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null . |
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. |
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. |
Methods inherited from class org.apache.catalina.realm.RealmBase |
addLifecycleListener, addPropertyChangeListener, authenticate, authenticate, authenticate, digest, Digest, findLifecycleListeners, getContainer, getDebug, getDigest, getDigest, getValidate, hasMessageDigest, hasRole, log, log, main, removeLifecycleListener, removePropertyChangeListener, setContainer, setDebug, setDigest, setValidate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
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.
Constructor Detail |
public UserDatabaseRealm()
Method Detail |
public java.lang.String getInfo()
<description>/<version>
.
getInfo
in interface Realm
getInfo
in class RealmBase
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 java.security.Principal authenticate(java.lang.String username, java.lang.String credentials)
null
.
authenticate
in interface Realm
authenticate
in class RealmBase
username
- Username of the Principal to look upcredentials
- Password or other credentials to use in
authenticating this usernameprotected java.lang.String getName()
getName
in class RealmBase
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 reported
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |