Package org.apache.catalina.realm
Class JDBCRealm
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.realm.RealmBase
org.apache.catalina.realm.JDBCRealm
- All Implemented Interfaces:
MBeanRegistration
,Contained
,JmxEnabled
,Lifecycle
,Realm
Deprecated.
Will be removed in Tomcat 10 onwards. Use the DataSourceRealm instead.
Implementation of Realm that works with any JDBC supported database. See the JDBCRealm.howto for more details
on how to set up the database and for configuration options.
For a Realm implementation that supports connection pooling and doesn't require synchronisation of
authenticate()
, getPassword()
, roles()
and getPrincipal()
or the
ugly connection logic use the DataSourceRealm
.
- Author:
- 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
Modifier and TypeFieldDescriptionprotected String
Deprecated.The connection username to use when trying to connect to the database.protected String
Deprecated.The connection URL to use when trying to connect to the database.protected String
Deprecated.The connection URL to use when trying to connect to the database.protected Connection
Deprecated.The connection to the database.protected Driver
Deprecated.Instance of the JDBC Driver class we use as a connection factory.protected String
Deprecated.The JDBC driver to use.protected PreparedStatement
Deprecated.The PreparedStatement to use for authenticating users.protected PreparedStatement
Deprecated.The PreparedStatement to use for identifying the roles for a specified user.protected String
Deprecated.The column in the user role table that names a roleprotected String
Deprecated.The column in the user table that holds the user's credentialsprotected String
Deprecated.The column in the user table that holds the user's nameprotected String
Deprecated.The table that holds the relation between user's and rolesprotected String
Deprecated.The table that holds user data.Fields inherited from class org.apache.catalina.realm.RealmBase
allRolesMode, container, containerLog, realmPath, sm, stripRealmForGss, support, USER_ATTRIBUTES_DELIMITER, USER_ATTRIBUTES_WILDCARD, userAttributes, userAttributesList, 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
-
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(String username, String credentials) Deprecated.Return the Principal associated with the specified username and credentials, if there is one; otherwise returnnull
.authenticate
(Connection dbConnection, String username, String credentials) Deprecated.Attempt to authenticate the user with the provided credentials.protected void
close
(Connection dbConnection) Deprecated.Close the specified database connection.protected PreparedStatement
credentials
(Connection dbConnection, String username) Deprecated.Return a PreparedStatement configured to perform the SELECT required to retrieve user credentials for the specified username.Deprecated.Deprecated.Deprecated.Deprecated.protected String
getPassword
(String username) Deprecated.Get the password for the specified user.protected Principal
getPrincipal
(String username) Deprecated.Get the principal associated with the specified user.Deprecated.Deprecated.Return the roles associated with the given user name.Deprecated.Deprecated.Deprecated.Deprecated.boolean
Deprecated.Return the availability of the realm for authentication.protected Connection
open()
Deprecated.Open (if necessary) and return a database connection for use by this Realm.protected PreparedStatement
roles
(Connection dbConnection, String username) Deprecated.Return a PreparedStatement configured to perform the SELECT required to retrieve user roles for the specified username.void
setConnectionName
(String connectionName) Deprecated.Set the username to use to connect to the database.void
setConnectionPassword
(String connectionPassword) Deprecated.Set the password to use to connect to the database.void
setConnectionURL
(String connectionURL) Deprecated.Set the URL to use to connect to the database.void
setDriverName
(String driverName) Deprecated.Set the JDBC driver that will be used.void
setRoleNameCol
(String roleNameCol) Deprecated.Set the column in the user role table that names a role.void
setUserCredCol
(String userCredCol) Deprecated.Set the column in the user table that holds the user's credentials.void
setUserNameCol
(String userNameCol) Deprecated.Set the column in the user table that holds the user's name.void
setUserRoleTable
(String userRoleTable) Deprecated.Set the table that holds the relation between user's and roles.void
setUserTable
(String userTable) Deprecated.Set the table that holds user data.protected void
Deprecated.Prepare for the beginning of active use of the public methods of this component and implement the requirements ofLifecycleBase.startInternal()
.protected void
Deprecated.Gracefully terminate the active use of the public methods of this component and implement the requirements ofLifecycleBase.stopInternal()
.Methods inherited from class org.apache.catalina.realm.RealmBase
addPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, backgroundProcess, findSecurityConstraints, getAllRolesMode, getContainer, getCredentialHandler, getDigest, getDigest, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getPrincipal, getPrincipal, getPrincipal, getRealmPath, getRealmSuffix, getRoles, getServer, getTransportGuaranteeRedirectStatus, getUserAttributes, getValidate, getX509UsernameRetrieverClassName, hasMessageDigest, hasResourcePermission, hasRole, hasRoleInternal, hasUserDataPermission, initInternal, isStripRealmForGss, main, parseUserAttributes, removePropertyChangeListener, setAllRolesMode, setContainer, setCredentialHandler, setRealmPath, setStripRealmForGss, setTransportGuaranteeRedirectStatus, setUserAttributes, setValidate, setX509UsernameRetrieverClassName, toString
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Field Details
-
connectionName
Deprecated.The connection username to use when trying to connect to the database. -
connectionPassword
Deprecated.The connection URL to use when trying to connect to the database. -
connectionURL
Deprecated.The connection URL to use when trying to connect to the database. -
dbConnection
Deprecated.The connection to the database. -
driver
Deprecated.Instance of the JDBC Driver class we use as a connection factory. -
driverName
Deprecated.The JDBC driver to use. -
preparedCredentials
Deprecated.The PreparedStatement to use for authenticating users. -
preparedRoles
Deprecated.The PreparedStatement to use for identifying the roles for a specified user. -
roleNameCol
Deprecated.The column in the user role table that names a role -
userCredCol
Deprecated.The column in the user table that holds the user's credentials -
userNameCol
Deprecated.The column in the user table that holds the user's name -
userRoleTable
Deprecated.The table that holds the relation between user's and roles -
userTable
Deprecated.The table that holds user data.
-
-
Constructor Details
-
JDBCRealm
public JDBCRealm()Deprecated.
-
-
Method Details
-
getConnectionName
Deprecated.- Returns:
- the username to use to connect to the database.
-
setConnectionName
Deprecated.Set the username to use to connect to the database.- Parameters:
connectionName
- Username
-
getConnectionPassword
Deprecated.- Returns:
- the password to use to connect to the database.
-
setConnectionPassword
Deprecated.Set the password to use to connect to the database.- Parameters:
connectionPassword
- User password
-
getConnectionURL
Deprecated.- Returns:
- the URL to use to connect to the database.
-
setConnectionURL
Deprecated.Set the URL to use to connect to the database.- Parameters:
connectionURL
- The new connection URL
-
getDriverName
Deprecated.- Returns:
- the JDBC driver that will be used.
-
setDriverName
Deprecated.Set the JDBC driver that will be used.- Parameters:
driverName
- The driver name
-
getRoleNameCol
Deprecated.- Returns:
- the column in the user role table that names a role.
-
setRoleNameCol
Deprecated.Set the column in the user role table that names a role.- Parameters:
roleNameCol
- The column name
-
getUserCredCol
Deprecated.- Returns:
- the column in the user table that holds the user's credentials.
-
setUserCredCol
Deprecated.Set the column in the user table that holds the user's credentials.- Parameters:
userCredCol
- The column name
-
getUserNameCol
Deprecated.- Returns:
- the column in the user table that holds the user's name.
-
setUserNameCol
Deprecated.Set the column in the user table that holds the user's name.- Parameters:
userNameCol
- The column name
-
getUserRoleTable
Deprecated.- Returns:
- the table that holds the relation between user's and roles.
-
setUserRoleTable
Deprecated.Set the table that holds the relation between user's and roles.- Parameters:
userRoleTable
- The table name
-
getUserTable
Deprecated.- Returns:
- the table that holds user data..
-
setUserTable
Deprecated.Set the table that holds user data.- Parameters:
userTable
- The table name
-
authenticate
Deprecated.Return the Principal associated with the specified username and credentials, if there is one; otherwise returnnull
. 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 interfaceRealm
- Overrides:
authenticate
in classRealmBase
- Parameters:
username
- Username of the Principal to look upcredentials
- Password or other credentials to use in authenticating this username- Returns:
- the associated principal, or
null
if there is none.
-
authenticate
Deprecated.Attempt to authenticate the user with the provided credentials.- Parameters:
dbConnection
- The database connection to be usedusername
- Username of the Principal to look upcredentials
- Password or other credentials to use in authenticating this username- Returns:
- Return the Principal associated with the specified username and credentials, if there is one; otherwise
return
null
.
-
isAvailable
public boolean isAvailable()Deprecated.Description copied from interface:Realm
Return the availability of the realm for authentication.- Returns:
true
if the realm is able to perform authentication
-
close
Deprecated.Close the specified database connection.- Parameters:
dbConnection
- The connection to be closed
-
credentials
protected PreparedStatement credentials(Connection dbConnection, String username) throws SQLException Deprecated.Return a PreparedStatement configured to perform the SELECT required to retrieve user credentials for the specified username.- Parameters:
dbConnection
- The database connection to be usedusername
- Username for which credentials should be retrieved- Returns:
- the prepared statement
- Throws:
SQLException
- if a database error occurs
-
getPassword
Deprecated.Get the password for the specified user.- Specified by:
getPassword
in classRealmBase
- Parameters:
username
- The user name- Returns:
- the password associated with the given principal's user name.
-
getPrincipal
Deprecated.Get the principal associated with the specified user.- Specified by:
getPrincipal
in classRealmBase
- Parameters:
username
- The user name- Returns:
- the Principal associated with the given user name.
-
getRoles
Deprecated.Return the roles associated with the given user name.- Parameters:
username
- The user name- Returns:
- an array list of the role names
-
open
Deprecated.Open (if necessary) and return a database connection for use by this Realm.- Returns:
- the opened connection
- Throws:
SQLException
- if a database error occurs
-
roles
Deprecated.Return a PreparedStatement configured to perform the SELECT required to retrieve user roles for the specified username.- Parameters:
dbConnection
- The database connection to be usedusername
- Username for which roles should be retrieved- Returns:
- the prepared statement
- Throws:
SQLException
- if a database error occurs
-
startInternal
Deprecated.Prepare for the beginning of active use of the public methods of this component and implement the requirements ofLifecycleBase.startInternal()
.- Overrides:
startInternal
in classRealmBase
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
-
stopInternal
Deprecated.Gracefully terminate the active use of the public methods of this component and implement the requirements ofLifecycleBase.stopInternal()
.- Overrides:
stopInternal
in classRealmBase
- Throws:
LifecycleException
- if this component detects a fatal error that needs to be reported
-