Class DataSourceRealm

  • All Implemented Interfaces:
    MBeanRegistration, Contained, GSSRealm, JmxEnabled, Lifecycle, Realm

    public class DataSourceRealm
    extends RealmBase
    Implementation of Realm that works with any JDBC JNDI DataSource. See the Realm How-To for more details on how to set up the database and for configuration options.
    Author:
    Glenn L. Nielsen, Craig R. McClanahan, Carson McDonald, Ignacio Ortega
    • Field Detail

      • dataSourceName

        protected String dataSourceName
        The name of the JNDI JDBC DataSource
      • localDataSource

        protected boolean localDataSource
        Context local datasource.
      • name

        @Deprecated
        protected static final String name
        Deprecated.
        This will be removed in Tomcat 9 onwards.
        Descriptive information about this Realm implementation.
        See Also:
        Constant Field Values
      • roleNameCol

        protected String roleNameCol
        The column in the user role table that names a role
      • userCredCol

        protected String userCredCol
        The column in the user table that holds the user's credentials
      • userNameCol

        protected String userNameCol
        The column in the user table that holds the user's name
      • userRoleTable

        protected String userRoleTable
        The table that holds the relation between user's and roles
      • userTable

        protected String userTable
        The table that holds user data.
    • Constructor Detail

      • DataSourceRealm

        public DataSourceRealm()
    • Method Detail

      • getDataSourceName

        public String getDataSourceName()
        Returns:
        the name of the JNDI JDBC DataSource.
      • setDataSourceName

        public void setDataSourceName​(String dataSourceName)
        Set the name of the JNDI JDBC DataSource.
        Parameters:
        dataSourceName - the name of the JNDI JDBC DataSource
      • getLocalDataSource

        public boolean getLocalDataSource()
        Returns:
        if the datasource will be looked up in the webapp JNDI Context.
      • setLocalDataSource

        public void setLocalDataSource​(boolean localDataSource)
        Set to true to cause the datasource to be looked up in the webapp JNDI Context.
        Parameters:
        localDataSource - the new flag value
      • getRoleNameCol

        public String getRoleNameCol()
        Returns:
        the column in the user role table that names a role.
      • setRoleNameCol

        public void setRoleNameCol​(String roleNameCol)
        Set the column in the user role table that names a role.
        Parameters:
        roleNameCol - The column name
      • getUserCredCol

        public String getUserCredCol()
        Returns:
        the column in the user table that holds the user's credentials.
      • setUserCredCol

        public void setUserCredCol​(String userCredCol)
        Set the column in the user table that holds the user's credentials.
        Parameters:
        userCredCol - The column name
      • getUserNameCol

        public String getUserNameCol()
        Returns:
        the column in the user table that holds the user's name.
      • setUserNameCol

        public void setUserNameCol​(String userNameCol)
        Set the column in the user table that holds the user's name.
        Parameters:
        userNameCol - The column name
      • getUserRoleTable

        public String getUserRoleTable()
        Returns:
        the table that holds the relation between user's and roles.
      • setUserRoleTable

        public void setUserRoleTable​(String userRoleTable)
        Set the table that holds the relation between user's and roles.
        Parameters:
        userRoleTable - The table name
      • getUserTable

        public String getUserTable()
        Returns:
        the table that holds user data..
      • setUserTable

        public void setUserTable​(String userTable)
        Set the table that holds user data.
        Parameters:
        userTable - The table name
      • authenticate

        public Principal authenticate​(String username,
                                      String credentials)
        Return the Principal associated with the specified username and credentials, if there is one; otherwise return null. If there are any errors with the JDBC connection, executing the query or anything we return null (don't authenticate). This event is also logged, and the connection will be closed so that a subsequent request will automatically re-open it.
        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.
      • isAvailable

        public boolean isAvailable()
        Description copied from interface: Realm
        Return the availability of the realm for authentication.
        Specified by:
        isAvailable in interface Realm
        Overrides:
        isAvailable in class RealmBase
        Returns:
        true if the realm is able to perform authentication
      • authenticate

        protected Principal authenticate​(Connection dbConnection,
                                         String username,
                                         String credentials)
        Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
        Parameters:
        dbConnection - The database connection to be used
        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.
      • close

        protected void close​(Connection dbConnection)
        Close the specified database connection.
        Parameters:
        dbConnection - The connection to be closed
      • open

        protected Connection open()
        Open the specified database connection.
        Returns:
        Connection to the database
      • getName

        @Deprecated
        protected String getName()
        Deprecated.
        Specified by:
        getName in class RealmBase
        Returns:
        a short name for this Realm implementation, for use in log messages.
      • getPassword

        protected String getPassword​(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.
      • getPassword

        protected String getPassword​(Connection dbConnection,
                                     String username)
        Return the password associated with the given principal's user name.
        Parameters:
        dbConnection - The database connection to be used
        username - Username for which password should be retrieved
        Returns:
        the password for the specified user
      • getPrincipal

        protected Principal getPrincipal​(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 object
      • getRoles

        protected ArrayList<String> getRoles​(String username)
        Return the roles associated with the given user name.
        Parameters:
        username - User name for which roles should be retrieved
        Returns:
        an array list of the role names
      • getRoles

        protected ArrayList<String> getRoles​(Connection dbConnection,
                                             String username)
        Return the roles associated with the given user name.
        Parameters:
        dbConnection - The database connection to be used
        username - User name for which roles should be retrieved
        Returns:
        an array list of the role names