Package org.apache.catalina.realm

Class UserDatabaseRealm

  • All Implemented Interfaces:
    javax.management.MBeanRegistration, Contained, GSSRealm, JmxEnabled, Lifecycle, Realm
    public class UserDatabaseRealm
extends RealmBase
    Implementation of Realm that is based on an implementation of UserDatabase made available through the JNDI resources configured for this instance of Catalina. Set the resourceName parameter to the JNDI resources name for the configured instance of UserDatabase that we should consult.
    Since:
    4.1
    Author:
    Craig R. McClanahan

    • Field Detail

      • database

        protected volatile UserDatabase database
        The UserDatabase we will use to authenticate users and identify associated roles.

      • 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

      • resourceName

        protected java.lang.String resourceName
        The global JNDI name of the UserDatabase resource we will be utilizing.

    • Constructor Detail

      • UserDatabaseRealm

        public UserDatabaseRealm()

    • Method Detail

      • getResourceName

        public java.lang.String getResourceName()
        Returns:
        the global JNDI name of the UserDatabase resource we will be using.

      • setResourceName

        public void setResourceName​(java.lang.String resourceName)
        Set the global JNDI name of the UserDatabase resource we will be using.
        Parameters:
        resourceName - The new global JNDI name

      • getLocalJndiResource

        public boolean getLocalJndiResource()
        Determines whether this Realm is configured to obtain the associated UserDatabase from the global JNDI context or a local (web application) JNDI context.
        Returns:
        true if a local JNDI context will be used, false if the the global JNDI context will be used

      • setLocalJndiResource

        public void setLocalJndiResource​(boolean localJndiResource)
        Configure whether this Realm obtains the associated UserDatabase from the global JNDI context or a local (web application) JNDI context.
        Parameters:
        localJndiResource - true to use a local JNDI context, false to use the global JNDI context

      • 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.

      • backgroundProcess

        public void backgroundProcess()
        Description copied from class: RealmBase
        Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
        Specified by:
        backgroundProcess in interface Realm
        Overrides:
        backgroundProcess in class RealmBase

      • getPassword

        protected java.lang.String getPassword​(java.lang.String username)
        Return the password associated with the given principal's user name.
        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)
        Return the Principal associated with the given user name.
        Specified by:
        getPrincipal in class RealmBase
        Parameters:
        username - The user name
        Returns:
        the Principal associated with the given user name.