File	Doc	Category	Size	Date	Package
MemoryRealm.java	API Doc	Apache Tomcat 6.0.14	9843	Fri Jul 20 04:20:34 BST 2007	org.apache.catalina.realm

MemoryRealm

• java.lang.Object
  • RealmBase

Fields Summary
private static org.apache.juli.logging.Log	log
private static org.apache.tomcat.util.digester.Digester	digester The Digester we will use to process in-memory database files.
protected final String	info Descriptive information about this Realm implementation.
protected static final String	name Descriptive information about this Realm implementation.
private String	pathname The pathname (absolute or relative to Catalina's current working directory) of the XML file containing our database information.
private Map	principals The set of valid Principals for this Realm, keyed by user name.
private static org.apache.catalina.util.StringManager	sm The string manager for this package.

Constructors Summary

Methods Summary
void	addUser(java.lang.String username, java.lang.String password, java.lang.String roles) Add a new user to the in-memory database. param username User's username param password User's password (clear text) param roles Comma-delimited set of roles associated with this user // Accumulate the list of roles for this user ArrayList<String> list = new ArrayList<String>(); roles += ","; while (true) { int comma = roles.indexOf(',"); if (comma < 0) break; String role = roles.substring(0, comma).trim(); list.add(role); roles = roles.substring(comma + 1); } // Construct and cache the Principal for this user GenericPrincipal principal = new GenericPrincipal(this, username, password, list); principals.put(username, principal);
public 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. param username Username of the Principal to look up param credentials Password or other credentials to use in authenticating this username GenericPrincipal principal = (GenericPrincipal) principals.get(username); boolean validated = false; if (principal != null) { if (hasMessageDigest()) { // Hex hashes should be compared case-insensitive validated = (digest(credentials) .equalsIgnoreCase(principal.getPassword())); } else { validated = (digest(credentials).equals(principal.getPassword())); } } if (validated) { if (log.isDebugEnabled()) log.debug(sm.getString("memoryRealm.authenticateSuccess", username)); return (principal); } else { if (log.isDebugEnabled()) log.debug(sm.getString("memoryRealm.authenticateFailure", username)); return (null); }
protected synchronized org.apache.tomcat.util.digester.Digester	getDigester() Return a configured Digester to use for processing the XML input file, creating a new one if necessary. if (digester == null) { digester = new Digester(); digester.setValidating(false); digester.addRuleSet(new MemoryRuleSet()); } return (digester);
public java.lang.String	getInfo() Return descriptive information about this Realm implementation and the corresponding version number, in the format <description>/<version>. // ------------------------------------------------------------- Properties return info;
protected java.lang.String	getName() Return a short name for this Realm implementation. return (name);
protected java.lang.String	getPassword(java.lang.String username) Return the password associated with the given principal's user name. GenericPrincipal principal = (GenericPrincipal) principals.get(username); if (principal != null) { return (principal.getPassword()); } else { return (null); }
public java.lang.String	getPathname() Return the pathname of our XML file containing user definitions. return pathname;
protected java.security.Principal	getPrincipal(java.lang.String username) Return the Principal associated with the given user name. return (Principal) principals.get(username);
protected java.util.Map	getPrincipals() Returns the principals for this realm. return The principals, keyed by user name (a String) return principals;
public void	setPathname(java.lang.String pathname) Set the pathname of our XML file containing user definitions. If a relative pathname is specified, it is resolved against "catalina.base". param pathname The new pathname this.pathname = pathname;
public synchronized void	start() Prepare for active use of the public methods of this Component. exception LifecycleException if this component detects a fatal error that prevents it from being started // Perform normal superclass initialization super.start(); // Validate the existence of our database file File file = new File(pathname); if (!file.isAbsolute()) file = new File(System.getProperty("catalina.base"), pathname); if (!file.exists() || !file.canRead()) throw new LifecycleException (sm.getString("memoryRealm.loadExist", file.getAbsolutePath())); // Load the contents of the database file if (log.isDebugEnabled()) log.debug(sm.getString("memoryRealm.loadPath", file.getAbsolutePath())); Digester digester = getDigester(); try { synchronized (digester) { digester.push(this); digester.parse(file); } } catch (Exception e) { throw new LifecycleException (sm.getString("memoryRealm.readXml"), e); } finally { digester.reset(); }
public synchronized void	stop() Gracefully shut down active use of the public methods of this Component. exception LifecycleException if this component detects a fatal error that needs to be reported // Perform normal superclass finalization super.stop(); // No shutdown activities required