DataSourceRealm (Apache Tomcat 8.0.53 API Documentation)

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

All Implemented Interfaces:

javax.management.MBeanRegistration, JmxEnabled, Lifecycle, Realm
```
public class DataSourceRealm
extends RealmBase
```
Implementation of Realm that works with any JDBC JNDI DataSource. See the JDBCRealm.howto 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

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 java.lang.String`	`dataSourceName` The name of the JNDI JDBC DataSource
`protected boolean`	`localDataSource` Context local datasource.
`protected static java.lang.String`	`name` Descriptive information about this Realm implementation.
`protected java.lang.String`	`roleNameCol` The column in the user role table that names a role
`protected java.lang.String`	`userCredCol` The column in the user table that holds the user's credentials
`protected java.lang.String`	`userNameCol` The column in the user table that holds the user's name
`protected java.lang.String`	`userRoleTable` The table that holds the relation between user's and roles
`protected java.lang.String`	`userTable` The table that holds user data.

Fields inherited from class org.apache.catalina.realm.RealmBase
allRolesMode, container, containerLog, digest, digestEncoding, md, md5Helper, 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

Constructor Summary

Constructors
Constructor and Description

DataSourceRealm()

Constructors
Constructor and Description
`DataSourceRealm()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.security.Principal`	`authenticate(java.sql.Connection dbConnection, 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`.
`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 void`	`close(java.sql.Connection dbConnection)` Close the specified database connection.
`java.lang.String`	`getDataSourceName()`
`boolean`	`getLocalDataSource()`
`protected java.lang.String`	`getName()` Return a short name for this Realm implementation.
`protected java.lang.String`	`getPassword(java.sql.Connection dbConnection, java.lang.String username)` Return the password associated with the given principal's user name.
`protected java.lang.String`	`getPassword(java.lang.String username)` Get the password for the specified user.
`protected java.security.Principal`	`getPrincipal(java.lang.String username)` Return the Principal associated with the given user name.
`java.lang.String`	`getRoleNameCol()`
`protected java.util.ArrayList<java.lang.String>`	`getRoles(java.sql.Connection dbConnection, java.lang.String username)` Return the roles associated with the given user name
`protected java.util.ArrayList<java.lang.String>`	`getRoles(java.lang.String username)` Return the roles associated with the given user name.
`java.lang.String`	`getUserCredCol()`
`java.lang.String`	`getUserNameCol()`
`java.lang.String`	`getUserRoleTable()`
`java.lang.String`	`getUserTable()`
`protected java.sql.Connection`	`open()` Open the specified database connection.
`void`	`setDataSourceName(java.lang.String dataSourceName)` Set the name of the JNDI JDBC DataSource.
`void`	`setLocalDataSource(boolean localDataSource)` Set to true to cause the datasource to be looked up in the webapp JNDI Context.
`void`	`setRoleNameCol(java.lang.String roleNameCol)` Set the column in the user role table that names a role.
`void`	`setUserCredCol(java.lang.String userCredCol)` Set the column in the user table that holds the user's credentials.
`void`	`setUserNameCol(java.lang.String userNameCol)` Set the column in the user table that holds the user's name.
`void`	`setUserRoleTable(java.lang.String userRoleTable)` Set the table that holds the relation between user's and roles.
`void`	`setUserTable(java.lang.String userTable)` Set the table that holds user data.
`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, compareCredentials, digest, Digest, findSecurityConstraints, getAllRolesMode, getContainer, getCredentialHandler, getDigest, getDigest, getDigestCharset, getDigestEncoding, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getPrincipal, getRealmPath, getRealmSuffix, getServer, getTransportGuaranteeRedirectStatus, getValidate, getX509UsernameRetrieverClassName, hasMessageDigest, hasResourcePermission, hasRole, hasUserDataPermission, initInternal, isStripRealmForGss, main, removePropertyChangeListener, setAllRolesMode, setContainer, setCredentialHandler, setDigest, setDigestEncoding, 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
  - dataSourceName
```
protected java.lang.String dataSourceName
```
    The name of the JNDI JDBC DataSource
  - localDataSource
```
protected boolean localDataSource
```
    Context local datasource.
  - name
```
protected static final java.lang.String name
```
    Descriptive information about this Realm implementation.
    
    See Also:
    Constant Field Values
  - roleNameCol
```
protected java.lang.String roleNameCol
```
    The column in the user role table that names a role
  - userCredCol
```
protected java.lang.String userCredCol
```
    The column in the user table that holds the user's credentials
  - userNameCol
```
protected java.lang.String userNameCol
```
    The column in the user table that holds the user's name
  - userRoleTable
```
protected java.lang.String userRoleTable
```
    The table that holds the relation between user's and roles
  - userTable
```
protected java.lang.String userTable
```
    The table that holds user data.
- Constructor Detail
  - DataSourceRealm
```
public DataSourceRealm()
```
- Method Detail
  - getDataSourceName
```
public java.lang.String getDataSourceName()
```
    Returns:
    the name of the JNDI JDBC DataSource.
  - setDataSourceName
```
public void setDataSourceName(java.lang.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 java.lang.String getRoleNameCol()
```
    Returns:
    the column in the user role table that names a role.
  - setRoleNameCol
```
public void setRoleNameCol(java.lang.String roleNameCol)
```
    Set the column in the user role table that names a role.
    
    Parameters:
    roleNameCol - The column name
  - getUserCredCol
```
public java.lang.String getUserCredCol()
```
    Returns:
    the column in the user table that holds the user's credentials.
  - setUserCredCol
```
public void setUserCredCol(java.lang.String userCredCol)
```
    Set the column in the user table that holds the user's credentials.
    
    Parameters:
    userCredCol - The column name
  - getUserNameCol
```
public java.lang.String getUserNameCol()
```
    Returns:
    the column in the user table that holds the user's name.
  - setUserNameCol
```
public void setUserNameCol(java.lang.String userNameCol)
```
    Set the column in the user table that holds the user's name.
    
    Parameters:
    userNameCol - The column name
  - getUserRoleTable
```
public java.lang.String getUserRoleTable()
```
    Returns:
    the table that holds the relation between user's and roles.
  - setUserRoleTable
```
public void setUserRoleTable(java.lang.String userRoleTable)
```
    Set the table that holds the relation between user's and roles.
    
    Parameters:
    userRoleTable - The table name
  - getUserTable
```
public java.lang.String getUserTable()
```
    Returns:
    the table that holds user data..
  - setUserTable
```
public void setUserTable(java.lang.String userTable)
```
    Set the table that holds user data.
    
    Parameters:
    userTable - The table name
  - 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. 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.
  - authenticate
```
protected java.security.Principal authenticate(java.sql.Connection dbConnection,
                                   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.
    
    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(java.sql.Connection dbConnection)
```
    Close the specified database connection.
    
    Parameters:
    dbConnection - The connection to be closed
  - open
```
protected java.sql.Connection open()
```
    Open the specified database connection.
    
    Returns:
    Connection to the database
  - getName
```
protected java.lang.String getName()
```
    Return a short name for this Realm implementation.
    
    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.
  - getPassword
```
protected java.lang.String getPassword(java.sql.Connection dbConnection,
                           java.lang.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 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 object
  - getRoles
```
protected java.util.ArrayList<java.lang.String> getRoles(java.lang.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 java.util.ArrayList<java.lang.String> getRoles(java.sql.Connection dbConnection,
                                             java.lang.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
  - 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 DataSourceRealm

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

dataSourceName

localDataSource

name

roleNameCol

userCredCol

userNameCol

userRoleTable

userTable

Constructor Detail

DataSourceRealm

Method Detail

getDataSourceName

setDataSourceName

getLocalDataSource

setLocalDataSource

getRoleNameCol

setRoleNameCol

getUserCredCol

setUserCredCol

getUserNameCol

setUserNameCol

getUserRoleTable

setUserRoleTable

getUserTable

setUserTable

authenticate

authenticate

close

open

getName

getPassword

getPassword

getPrincipal

getRoles

getRoles

startInternal