dataSourceName
protected String dataSourceName
The name of the JNDI JDBC DataSource
info
protected static final String info
Descriptive information about this Realm implementation.
localDataSource
protected boolean localDataSource
Context local datasource.
name
protected static final String name
Descriptive information about this Realm implementation.
roleNameCol
protected String roleNameCol
The column in the user role table that names a role
sm
protected static final StringManager sm
The string manager for this package.
userCredCol
protected String userCredCol
The column in the user table that holds the user's credintials
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.
authenticate
protected Principal authenticate(Connection dbConnection,
String username,
String credentials)
throws SQLException
Return the Principal associated with the specified username and
credentials, if there is one; otherwise return null
.
dbConnection
- The database connection to be usedusername
- Username of the Principal to look upcredentials
- Password or other credentials to use in
authenticating this username
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.
- authenticate in interface Realm
- authenticate in interface RealmBase
username
- Username of the Principal to look upcredentials
- Password or other credentials to use in
authenticating this username
close
protected void close(Connection dbConnection)
Close the specified database connection.
dbConnection
- The connection to be closed
getDataSourceName
public String getDataSourceName()
Return the name of the JNDI JDBC DataSource.
getLocalDataSource
public boolean getLocalDataSource()
Return if the datasource will be looked up in the webapp JNDI Context.
getName
protected String getName()
Return a short name for this Realm implementation.
- getName in interface RealmBase
getPassword
protected String getPassword(String username)
Return the password associated with the given principal's user name.
- getPassword in interface RealmBase
getPrincipal
protected Principal getPrincipal(String username)
Return the Principal associated with the given user name.
- getPrincipal in interface RealmBase
getRoleNameCol
public String getRoleNameCol()
Return the column in the user role table that names a role.
getUserCredCol
public String getUserCredCol()
Return the column in the user table that holds the user's credentials.
getUserNameCol
public String getUserNameCol()
Return the column in the user table that holds the user's name.
getUserRoleTable
public String getUserRoleTable()
Return the table that holds the relation between user's and roles.
getUserTable
public String getUserTable()
Return the table that holds user data..
open
protected Connection open()
Open the specified database connection.
- Connection to the database
setDataSourceName
public void setDataSourceName(String dataSourceName)
Set the name of the JNDI JDBC DataSource.
dataSourceName
- the name of the JNDI JDBC DataSource
setLocalDataSource
public void setLocalDataSource(boolean localDataSource)
Set to true to cause the datasource to be looked up in the webapp JNDI
Context.
localDataSource
- the new flag value
setRoleNameCol
public void setRoleNameCol(String roleNameCol)
Set the column in the user role table that names a role.
roleNameCol
- The column name
setUserCredCol
public void setUserCredCol(String userCredCol)
Set the column in the user table that holds the user's credentials.
userCredCol
- The column name
setUserNameCol
public void setUserNameCol(String userNameCol)
Set the column in the user table that holds the user's name.
userNameCol
- The column name
setUserRoleTable
public void setUserRoleTable(String userRoleTable)
Set the table that holds the relation between user's and roles.
userRoleTable
- The table name
setUserTable
public void setUserTable(String userTable)
Set the table that holds user data.
userTable
- The table name