|
Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.realm.RealmBase
org.apache.catalina.realm.UserDatabaseRealm
public class 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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.catalina.realm.RealmBase |
|---|
RealmBase.AllRolesMode |
| 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 |
|---|
allRolesMode, container, containerLog, controller, digest, digestEncoding, domain, host, initialized, lifecycle, md, md5Encoder, md5Helper, mserver, oname, path, realmPath, started, support, type, validate, x509UsernameRetriever, x509UsernameRetrieverClassName |
| Fields inherited from interface org.apache.catalina.Lifecycle |
|---|
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT |
| Constructor Summary | |
|---|---|
UserDatabaseRealm()
|
|
| Method Summary | |
|---|---|
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. |
| 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 RealmgetInfo in class RealmBasepublic 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 name
public 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.
hasRole in interface RealmhasRole in class RealmBaseprincipal - Principal for whom the role is to be checkedrole - Security role to be checkedprotected java.lang.String getName()
getName in class RealmBaseprotected java.lang.String getPassword(java.lang.String username)
getPassword in class RealmBaseprotected java.security.Principal getPrincipal(java.lang.String username)
getPrincipal in class RealmBase
public void start()
throws LifecycleException
start in interface Lifecyclestart in class RealmBaseLifecycleException - if this component detects a fatal error
that prevents it from being started
public void stop()
throws LifecycleException
stop in interface Lifecyclestop in class RealmBaseLifecycleException - if this component detects a fatal error
that needs to be reported
|
Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||