org.apache.catalina.realm
public class DataSourceRealm extends RealmBase
Version: $Revision: 892553 $
Field Summary | |
---|---|
protected String | dataSourceName
The name of the JNDI JDBC DataSource |
protected static String | info
Descriptive information about this Realm implementation. |
protected boolean | localDataSource
Context local datasource. |
protected static String | name
Descriptive information about this Realm implementation. |
protected String | roleNameCol
The column in the user role table that names a role |
protected static StringManager | sm
The string manager for this package. |
protected String | userCredCol
The column in the user table that holds the user's credintials |
protected String | userNameCol
The column in the user table that holds the user's name |
protected String | userRoleTable
The table that holds the relation between user's and roles |
protected String | userTable
The table that holds user data. |
Method Summary | |
---|---|
Principal | authenticate(String username, String credentials)
Return the Principal associated with the specified username and
credentials, if there is one; otherwise return null .
|
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 .
|
protected void | close(Connection dbConnection)
Close the specified database connection.
|
String | getDataSourceName()
Return the name of the JNDI JDBC DataSource.
|
boolean | getLocalDataSource()
Return if the datasource will be looked up in the webapp JNDI Context. |
protected String | getName()
Return a short name for this Realm implementation. |
protected String | getPassword(String username)
Return the password associated with the given principal's user name. |
protected String | getPassword(Connection dbConnection, String username)
Return the password associated with the given principal's user name. |
protected Principal | getPrincipal(String username)
Return the Principal associated with the given user name. |
String | getRoleNameCol()
Return the column in the user role table that names a role.
|
protected ArrayList | getRoles(String username)
Return the roles associated with the given user name. |
protected ArrayList<String> | getRoles(Connection dbConnection, String username)
Return the roles associated with the given user name |
String | getUserCredCol()
Return the column in the user table that holds the user's credentials.
|
String | getUserNameCol()
Return the column in the user table that holds the user's name.
|
String | getUserRoleTable()
Return the table that holds the relation between user's and roles.
|
String | getUserTable()
Return the table that holds user data..
|
protected Connection | open()
Open the specified database connection.
|
void | setDataSourceName(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(String roleNameCol)
Set the column in the user role table that names a role.
|
void | setUserCredCol(String userCredCol)
Set the column in the user table that holds the user's credentials.
|
void | setUserNameCol(String userNameCol)
Set the column in the user table that holds the user's name.
|
void | setUserRoleTable(String userRoleTable)
Set the table that holds the relation between user's and roles.
|
void | setUserTable(String userTable)
Set the table that holds user data.
|
void | start()
Prepare for active use of the public methods of this Component.
|
void | stop()
Gracefully shut down active use of the public methods of this Component.
|
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.
Parameters: username Username of the Principal to look up credentials Password or other credentials to use in authenticating this username
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
Parameters: dbConnection The connection to be closed
Parameters: dbConnection The database connection to be used username Username for which password should be retrieved
Parameters: username Username for which roles should be retrieved
Parameters: dbConnection The database connection to be used username Username for which roles should be retrieved
Returns: Connection to the database
Parameters: dataSourceName the name of the JNDI JDBC DataSource
Parameters: localDataSource the new flag value
Parameters: roleNameCol The column name
Parameters: userCredCol The column name
Parameters: userNameCol The column name
Parameters: userRoleTable The table name
Parameters: userTable The table name
Throws: LifecycleException if this component detects a fatal error that prevents it from being started
Throws: LifecycleException if this component detects a fatal error that needs to be reported