org.apache.catalina.realm
public class DataSourceRealm extends RealmBase
RealmBase.AllRolesMode
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
dataSourceName
The name of the JNDI JDBC DataSource
|
protected static java.lang.String |
info
Descriptive information about this Realm implementation.
|
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 static StringManager |
sm
The string manager for this package.
|
protected java.lang.String |
userCredCol
The column in the user table that holds the user's credintials
|
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.
|
allRolesMode, container, containerLog, controller, digest, digestEncoding, domain, host, initialized, lifecycle, md, md5Encoder, md5Helper, mserver, oname, path, realmPath, started, support, type, validate
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
DataSourceRealm() |
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()
Return the name of the JNDI JDBC DataSource.
|
java.lang.String |
getInfo()
Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version> . |
boolean |
getLocalDataSource()
Return if the datasource will be looked up in the webapp JNDI Context.
|
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)
Return the password associated with the given principal's user name.
|
protected java.security.Principal |
getPrincipal(java.lang.String username)
Return the Principal associated with the given user name.
|
java.lang.String |
getRoleNameCol()
Return the column in the user role table that names a role.
|
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 |
getRoles(java.lang.String username)
Return the roles associated with the given user name.
|
java.lang.String |
getUserCredCol()
Return the column in the user table that holds the user's credentials.
|
java.lang.String |
getUserNameCol()
Return the column in the user table that holds the user's name.
|
java.lang.String |
getUserRoleTable()
Return the table that holds the relation between user's and roles.
|
java.lang.String |
getUserTable()
Return the table that holds user data..
|
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.
|
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.
|
addLifecycleListener, addPropertyChangeListener, authenticate, authenticate, authenticate, backgroundProcess, destroy, digest, Digest, findLifecycleListeners, findSecurityConstraints, getAllRolesMode, getContainer, getController, getDigest, getDigest, getDigestEncoding, getDomain, getObjectName, getPrincipal, getRealmPath, getRealmSuffix, getType, getValidate, hasMessageDigest, hasResourcePermission, hasRole, hasUserDataPermission, init, main, postDeregister, postRegister, preDeregister, preRegister, removeLifecycleListener, removePropertyChangeListener, setAllRolesMode, setContainer, setController, setDigest, setDigestEncoding, setRealmPath, setValidate
protected java.lang.String dataSourceName
protected static final java.lang.String info
protected boolean localDataSource
protected static final java.lang.String name
protected java.lang.String roleNameCol
protected static final StringManager sm
protected java.lang.String userCredCol
protected java.lang.String userNameCol
protected java.lang.String userRoleTable
protected java.lang.String userTable
public java.lang.String getDataSourceName()
public void setDataSourceName(java.lang.String dataSourceName)
dataSourceName
- the name of the JNDI JDBC DataSourcepublic boolean getLocalDataSource()
public void setLocalDataSource(boolean localDataSource)
localDataSource
- the new flag valuepublic java.lang.String getRoleNameCol()
public void setRoleNameCol(java.lang.String roleNameCol)
roleNameCol
- The column namepublic java.lang.String getUserCredCol()
public void setUserCredCol(java.lang.String userCredCol)
userCredCol
- The column namepublic java.lang.String getUserNameCol()
public void setUserNameCol(java.lang.String userNameCol)
userNameCol
- The column namepublic java.lang.String getUserRoleTable()
public void setUserRoleTable(java.lang.String userRoleTable)
userRoleTable
- The table namepublic java.lang.String getUserTable()
public void setUserTable(java.lang.String userTable)
userTable
- The table namepublic java.lang.String getInfo()
<description>/<version>
.public java.security.Principal authenticate(java.lang.String username, java.lang.String credentials)
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.authenticate
in interface Realm
authenticate
in class RealmBase
username
- Username of the Principal to look upcredentials
- Password or other credentials to use in
authenticating this usernameprotected java.security.Principal authenticate(java.sql.Connection dbConnection, java.lang.String username, java.lang.String credentials) throws java.sql.SQLException
null
.dbConnection
- The database connection to be usedusername
- Username of the Principal to look upcredentials
- Password or other credentials to use in
authenticating this usernamejava.sql.SQLException
protected void close(java.sql.Connection dbConnection)
dbConnection
- The connection to be closedprotected java.sql.Connection open()
protected java.lang.String getName()
protected java.lang.String getPassword(java.lang.String username)
getPassword
in class RealmBase
protected java.lang.String getPassword(java.sql.Connection dbConnection, java.lang.String username)
dbConnection
- The database connection to be usedusername
- Username for which password should be retrievedprotected java.security.Principal getPrincipal(java.lang.String username)
getPrincipal
in class RealmBase
protected java.util.ArrayList getRoles(java.lang.String username)
username
- Username for which roles should be retrievedprotected java.util.ArrayList<java.lang.String> getRoles(java.sql.Connection dbConnection, java.lang.String username)
dbConnection
- The database connection to be usedusername
- Username for which roles should be retrievedpublic void start() throws LifecycleException
start
in interface Lifecycle
start
in class RealmBase
LifecycleException
- if this component detects a fatal error
that prevents it from being startedpublic void stop() throws LifecycleException
stop
in interface Lifecycle
stop
in class RealmBase
LifecycleException
- if this component detects a fatal error
that needs to be reportedCopyright © 2000-2013 Apache Software Foundation. All Rights Reserved.