MemoryRealm (Apache Tomcat 8.5.43 API Documentation)

java.lang.Object
- org.apache.catalina.util.LifecycleBase
- - org.apache.catalina.util.LifecycleMBeanBase
  - - org.apache.catalina.realm.RealmBase
    - - org.apache.catalina.realm.MemoryRealm

All Implemented Interfaces:

javax.management.MBeanRegistration, JmxEnabled, Lifecycle, Realm

Direct Known Subclasses:

JAASMemoryLoginModule
```
public class MemoryRealm
extends RealmBase
```
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.

Author:

Craig R. McClanahan

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.catalina.realm.RealmBase
  RealmBase.AllRolesMode
- Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
  Lifecycle.SingleUse

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String name
Deprecated.
This will be removed in Tomcat 9 onwards.
- Fields inherited from class org.apache.catalina.realm.RealmBase
  allRolesMode, container, containerLog, realmPath, sm, stripRealmForGss, support, validate, x509UsernameRetriever, x509UsernameRetrieverClassName
- Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
  mserver
- Fields inherited from interface org.apache.catalina.Lifecycle
  AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`name` Deprecated. This will be removed in Tomcat 9 onwards.

Constructor Summary

Constructors
Constructor and Description

MemoryRealm()

Constructors
Constructor and Description
`MemoryRealm()`

Method Summary

Methods
Modifier and Type	Method and Description
`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()`
`protected java.lang.String`	`getName()` Deprecated.
`protected java.lang.String`	`getPassword(java.lang.String username)` Get the password for the specified user.
`java.lang.String`	`getPathname()`
`protected java.security.Principal`	`getPrincipal(java.lang.String username)` Get the principal associated with the specified user.
`void`	`setPathname(java.lang.String pathname)` Set the pathname of our XML file containing user definitions.
`protected void`	`startInternal()` Prepare for the beginning of active use of the public methods of this component and implement the requirements of `LifecycleBase.startInternal()`.

Methods inherited from class org.apache.catalina.realm.RealmBase
addPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, backgroundProcess, Digest, findSecurityConstraints, getAllRolesMode, getContainer, getCredentialHandler, getDigest, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getPrincipal, getRealmPath, getRealmSuffix, getRoles, getServer, getTransportGuaranteeRedirectStatus, getValidate, getX509UsernameRetrieverClassName, hasMessageDigest, hasResourcePermission, hasRole, hasRoleInternal, hasUserDataPermission, initInternal, isAvailable, isStripRealmForGss, main, removePropertyChangeListener, setAllRolesMode, setContainer, setCredentialHandler, setRealmPath, setStripRealmForGss, setTransportGuaranteeRedirectStatus, setValidate, setX509UsernameRetrieverClassName, stopInternal, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
@Deprecated
protected static final java.lang.String name
```
    Deprecated. This will be removed in Tomcat 9 onwards.
    
    Descriptive information about this Realm implementation.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MemoryRealm
```
public MemoryRealm()
```
- Method Detail
  - getPathname
```
public java.lang.String getPathname()
```
    Returns:
    the pathname of our XML file containing user definitions.
  - setPathname
```
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".
    
    Parameters:
    pathname - The new pathname
  - authenticate
```
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.
    
    Specified by:
    
    authenticate in interface Realm
    
    Overrides:
    
    authenticate in class RealmBase
    
    Parameters:
    username - Username of the Principal to look up
    credentials - Password or other credentials to use in authenticating this username
    
    Returns:
    the associated principal, or null if there is none.
  - getDigester
```
protected Digester getDigester()
```
    Returns:
    a configured Digester to use for processing the XML input file, creating a new one if necessary.
  - getName
```
@Deprecated
protected java.lang.String getName()
```
    Deprecated.
    
    Specified by:
    
    getName in class RealmBase
    
    Returns:
    a short name for this Realm implementation, for use in log messages.
  - getPassword
```
protected java.lang.String getPassword(java.lang.String username)
```
    Description copied from class: RealmBase
    
    Get the password for the specified user.
    
    Specified by:
    
    getPassword in class RealmBase
    
    Parameters:
    username - The user name
    
    Returns:
    the password associated with the given principal's user name.
  - getPrincipal
```
protected java.security.Principal getPrincipal(java.lang.String username)
```
    Description copied from class: RealmBase
    
    Get the principal associated with the specified user.
    
    Specified by:
    
    getPrincipal in class RealmBase
    
    Parameters:
    username - The user name
    
    Returns:
    the Principal associated with the given user name.
  - startInternal
```
protected void startInternal()
                      throws LifecycleException
```
    Prepare for the beginning of active use of the public methods of this component and implement the requirements of LifecycleBase.startInternal().
    
    Overrides:
    
    startInternal in class RealmBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used

Class MemoryRealm

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.realm.RealmBase

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Field Summary

Fields inherited from class org.apache.catalina.realm.RealmBase

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.realm.RealmBase

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

Methods inherited from class org.apache.catalina.util.LifecycleBase

Methods inherited from class java.lang.Object

Field Detail

name

Constructor Detail

MemoryRealm

Method Detail

getPathname

setPathname

authenticate

getDigester

getName

getPassword

getPrincipal

startInternal