| 
 | 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.MemoryRealm
public class MemoryRealm
Simple implementation of Realm that reads an XML file to configure the valid users, passwords, and roles. The file format (and default file location) are identical to those currently supported by Tomcat 3.X.
IMPLEMENTATION NOTE: It is assumed that the in-memory collection representing our defined users (and their roles) is initialized at application startup and never modified again. Therefore, no thread synchronization is performed around accesses to the principals collection.
| Nested Class Summary | 
|---|
| Nested classes/interfaces inherited from class org.apache.catalina.realm.RealmBase | 
|---|
| RealmBase.AllRolesMode | 
| Field Summary | |
|---|---|
| protected  java.lang.String | infoDescriptive information about this Realm implementation. | 
| protected static java.lang.String | nameDescriptive information about this Realm implementation. | 
| 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 | |
|---|---|
| MemoryRealm() | |
| 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. | 
| protected  Digester | getDigester()Return a configured Digesterto use for processing
 the XML input file, creating a new one if necessary. | 
|  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. | 
|  java.lang.String | getPathname()Return the pathname of our XML file containing user definitions. | 
| protected  java.security.Principal | getPrincipal(java.lang.String username)Return the Principal associated with the given user name. | 
| protected  java.util.Map | getPrincipals()Returns the principals for this realm. | 
|  void | setPathname(java.lang.String pathname)Set the pathname of our XML file containing user definitions. | 
|  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 final java.lang.String info
protected static final java.lang.String name
| Constructor Detail | 
|---|
public MemoryRealm()
| Method Detail | 
|---|
public java.lang.String getInfo()
<description>/<version>.
getInfo in interface RealmgetInfo in class RealmBasepublic java.lang.String getPathname()
public void setPathname(java.lang.String pathname)
pathname - The new pathname
public java.security.Principal authenticate(java.lang.String username,
                                            java.lang.String credentials)
null.
authenticate in interface Realmauthenticate in class RealmBaseusername - Username of the Principal to look upcredentials - Password or other credentials to use in
  authenticating this usernameprotected Digester getDigester()
Digester to use for processing
 the XML input file, creating a new one if necessary.
protected 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 RealmBaseprotected java.util.Map getPrincipals()
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 | ||||||||