Java Doc for JDBCEncryptionRealm.java in » J2EE » Jaffa » org » jaffa » tomcat » realm » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » J2EE » Jaffa » org.jaffa.tomcat.realm

Source Cross Reference Class Diagram Java Document (Java Doc)

org.jaffa.tomcat.realm .JDBCEncryptionRealm

JDBCEncryptionRealm

public class JDBCEncryptionRealm extends RealmBase (Code)

This Realm included the functionality of both the standard tomcat org.apache.catalina.realm.JDBCRealm JDBCRealm and the org.apache.catalina.realm.DataSourceRealm DataSourceRealm , in one class. It also included the ability to perform custom password encryption using 3rd party classes (if your encryption scheme is not supported by the default MessageDigest class in the JCE libraries).

This new version works with Tomcat 4.1 and higher, the previous version that doesn't have the DataSource code in it, works with ther earlier Tomcat 4.0 release

The code based for this classes was taken from the Tomcat 4.1.26 release

The two properties used for encryption are : encryptionClass and encryptionMethod.

With these set, the realm introspects for the named class for the names method. It is expected that the method has one of the following signatures

 public static String methodName(String password)

 public static String methodName(String password, String username)

The method should return a string, that should match the value retrieved from the database. This allow one-way encryption algorithms to be used. No decryption facility needs to be provided.

In addition to the original JDBCRealm/DataSource this realm

does not throw a NullPointerException if the database password is null
considers a user validated if the database and entered password are both null
provided one-way password encryption prior to comparing them
allows extention to the query to get the user's credentials
allows a custom query to be suppplied for getting the user's roles
Message levels for 'debug' parameter are 0 ->None, 2+ ->Errors, 5+ ->Warnings, 10+ ->Debug

New in Version 1.3

Adds support for DataSources. If the 'dataSourceName' is passed it overrides the use of a regular connection, therefore it ignores the values for connectionName, connectionPassword, connectionURL and driverName
Uses its own LocalStrings for messages, incase you want to implement a diffenent language

For more documentation see the Jaffa Web Site

author:
Paul Extance
version:
1.3

Field Summary
protected String	connectionName The connection username to use when trying to connect to the database.
protected String	connectionPassword The connection URL to use when trying to connect to the database.
protected String	connectionURL The connection URL to use when trying to connect to the database.
protected String	dataSourceName
protected Connection	dbConnection The connection to the database.
protected Driver	driver Instance of the JDBC Driver class we use as a connection factory.
protected String	driverName The JDBC driver to use.
final protected static String	info Descriptive information about this Realm implementation.
final protected static String	name Descriptive information about this Realm implementation.
protected PreparedStatement	preparedCredentials The PreparedStatement to use for authenticating users.
protected PreparedStatement	preparedRoles The PreparedStatement to use for identifying the roles for a specified user.
protected String	roleNameCol
final protected static StringManager	sm The string manager for this package.
protected String	userCredCol
protected String	userNameCol
protected String	userRoleTable
protected String	userTable The table that holds user data.

Method Summary
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).
protected void	close(Connection dbConnection) Close the specified database connection.
protected PreparedStatement	credentials(Connection dbConnection, String username) Return a PreparedStatement configured to perform the SELECT required to retrieve user credentials for the specified username.
public String	getConnectionName() Return the username to use to connect to the database.
public String	getConnectionPassword() Return the password to use to connect to the database.
public String	getConnectionURL() Return the URL to use to connect to the database.
public String	getDataSourceName() Return the name of the JNDI JDBC DataSource.
public String	getDriverName() Return the JDBC driver that will be used.
public String	getEncryptionClass()
public String	getEncryptionMethod()
protected String	getName() Return a short name for this Realm implementation.
protected String	getPassword(String username) Not Implemented - Return the password associated with the given principal's user name.
protected Principal	getPrincipal(String username) Not Implemented - Return the Principal associated with the given user name.
public String	getRoleNameCol() Return the column in the user role table that names a role.
public String	getRoleSelect()
public String	getUserClause() Getter for property userClause.
public String	getUserCredCol() Return the column in the user table that holds the user's credentials.
public String	getUserNameCol() Return the column in the user table that holds the user's name.
public String	getUserRoleTable() Return the table that holds the relation between user's and roles.
public String	getUserTable() Return the table that holds user data.
protected Connection	open() Open (if necessary) and return a database connection for use by this Realm.
protected void	release(Connection dbConnection) Release our use of this connection so that it can be recycled.
protected PreparedStatement	roles(Connection dbConnection, String username) Return a PreparedStatement configured to perform the SELECT required to retrieve user roles for the specified username.
public void	setConnectionName(String connectionName) Set the username to use to connect to the database.
public void	setConnectionPassword(String connectionPassword) Set the password to use to connect to the database.
public void	setConnectionURL(String connectionURL) Set the URL to use to connect to the database.
public void	setDataSourceName(String dataSourceName) Set the name of the JNDI JDBC DataSource.
public void	setDriverName(String driverName) Set the JDBC driver that will be used.
public void	setEncryptionClass(String encryptionClass) Setter for property encryptionClass.
public void	setEncryptionMethod(String encryptionMethod) Setter for property encryptionMethod.
public void	setRoleNameCol(String roleNameCol) Set the column in the user role table that names a role.
public void	setRoleSelect(String roleSelect) Setter for property roleSelect.
public void	setUserClause(String userClause) Setter for property userClause.
public void	setUserCredCol(String userCredCol) Set the column in the user table that holds the user's credentials.
public void	setUserNameCol(String userNameCol) Set the column in the user table that holds the user's name.
public void	setUserRoleTable(String userRoleTable) Set the table that holds the relation between user's and roles.
public void	setUserTable(String userTable) Set the table that holds user data.
public void	start() Prepare for active use of the public methods of this Component.
public void	stop() Gracefully shut down active use of the public methods of this Component.

Field Detail

connectionName
protected String connectionName(Code)
	The connection username to use when trying to connect to the database.

connectionPassword
protected String connectionPassword(Code)
	The connection URL to use when trying to connect to the database.

connectionURL
protected String connectionURL(Code)
	The connection URL to use when trying to connect to the database.

dataSourceName
protected String dataSourceName(Code)
	The name of the JNDI JDBC DataSource

dbConnection
protected Connection dbConnection(Code)
	The connection to the database.

driver
protected Driver driver(Code)
	Instance of the JDBC Driver class we use as a connection factory.

driverName
protected String driverName(Code)
	The JDBC driver to use.

info
final protected static String info(Code)
	Descriptive information about this Realm implementation.

name
final protected static String name(Code)
	Descriptive information about this Realm implementation.

preparedCredentials
protected PreparedStatement preparedCredentials(Code)
	The PreparedStatement to use for authenticating users.

preparedRoles
protected PreparedStatement preparedRoles(Code)
	The PreparedStatement to use for identifying the roles for a specified user.

roleNameCol
protected String roleNameCol(Code)
	The column in the user role table that names a role

sm
final protected static StringManager sm(Code)
	The string manager for this package.

userCredCol
protected String userCredCol(Code)
	The column in the user table that holds the user's credintials

userNameCol
protected String userNameCol(Code)
	The column in the user table that holds the user's name

userRoleTable
protected String userRoleTable(Code)
	The table that holds the relation between user's and roles

userTable
protected String userTable(Code)
	The table that holds user data.

Method Detail

authenticate
public Principal authenticate(String username, String credentials)(Code)
	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. Parameters: username - Username of the Principal to look up Parameters: credentials - Password or other credentials to use inauthenticating this username Authenticated principle object, with role access defined

close
protected void close(Connection dbConnection)(Code)
	Close the specified database connection. Parameters: dbConnection - The connection to be closed

credentials
protected PreparedStatement credentials(Connection dbConnection, String username) throws SQLException(Code)
	Return a PreparedStatement configured to perform the SELECT required to retrieve user credentials for the specified username. Parameters: dbConnection - The database connection to be used Parameters: username - Username for which credentials should be retrieved exception: SQLException - if a database error occurs PreparedStatement to read user's password

getConnectionName
public String getConnectionName()(Code)
	Return the username to use to connect to the database. Username to use to connect to the database

getConnectionPassword
public String getConnectionPassword()(Code)
	Return the password to use to connect to the database. Password to use to connect to the database

getConnectionURL
public String getConnectionURL()(Code)
	Return the URL to use to connect to the database. URL to use to connect to the database

getDataSourceName
public String getDataSourceName()(Code)
	Return the name of the JNDI JDBC DataSource. since: 1.3 Name of the JNDI JDBC DataSource

getDriverName
public String getDriverName()(Code)
	Return the JDBC driver that will be used. JDBC driver that will be used

getEncryptionClass
public String getEncryptionClass()(Code)
	Return the class used for encryption Class used for encryption

getEncryptionMethod
public String getEncryptionMethod()(Code)
	Return the method used for encryption Method used for encryption

getName
protected String getName()(Code)
	Return a short name for this Realm implementation. Short name for this Realm implementation

getPassword
protected String getPassword(String username)(Code)
	Not Implemented - Return the password associated with the given principal's user name. Parameters: username - User's Name Returns null in all cases

getPrincipal
protected Principal getPrincipal(String username)(Code)
	Not Implemented - Return the Principal associated with the given user name. Parameters: username - User's Name Returns null in all cases

getRoleNameCol
public String getRoleNameCol()(Code)
	Return the column in the user role table that names a role. Column in the user role table that names a role

getRoleSelect
public String getRoleSelect()(Code)
	Return the alternative select statement for reading the roles Alternative select statement for reading the roles

getUserClause
public String getUserClause()(Code)
	Getter for property userClause. Value of property userClause.

getUserCredCol
public String getUserCredCol()(Code)
	Return the column in the user table that holds the user's credentials. Column in the user table that holds the user's credentials

getUserNameCol
public String getUserNameCol()(Code)
	Return the column in the user table that holds the user's name. Column in the user table that holds the user's name

getUserRoleTable
public String getUserRoleTable()(Code)
	Return the table that holds the relation between user's and roles. Table that holds the relation between user's and roles

getUserTable
public String getUserTable()(Code)
	Return the table that holds user data. Table that holds user data

open
protected Connection open() throws SQLException(Code)
	Open (if necessary) and return a database connection for use by this Realm. Tries to use a data source if defined, otherwise open a direct connection using the specified database driver exception: SQLException - if a database error occurs Connection to the database

release
protected void release(Connection dbConnection) throws SQLException(Code)
	Release our use of this connection so that it can be recycled. Only puts the connection back in the pool if using a DataSource, otherwise the connection is held open. Parameters: dbConnection - Connection to release throws: SQLException - If there is an error with the database

roles
protected PreparedStatement roles(Connection dbConnection, String username) throws SQLException(Code)
	Return a PreparedStatement configured to perform the SELECT required to retrieve user roles for the specified username. Parameters: dbConnection - The database connection to be used Parameters: username - Username for which roles should be retrieved exception: SQLException - if a database error occurs PreparedStatement to read user's roles

setConnectionName
public void setConnectionName(String connectionName)(Code)
	Set the username to use to connect to the database. Parameters: connectionName - Username

setConnectionPassword
public void setConnectionPassword(String connectionPassword)(Code)
	Set the password to use to connect to the database. Parameters: connectionPassword - User password

setConnectionURL
public void setConnectionURL(String connectionURL)(Code)
	Set the URL to use to connect to the database. Parameters: connectionURL - The new connection URL

setDataSourceName
public void setDataSourceName(String dataSourceName)(Code)
	Set the name of the JNDI JDBC DataSource. Parameters: dataSourceName - the name of the JNDI JDBC DataSource since: 1.3

setDriverName
public void setDriverName(String driverName)(Code)
	Set the JDBC driver that will be used. Parameters: driverName - The driver name

setEncryptionClass
public void setEncryptionClass(String encryptionClass)(Code)
	Setter for property encryptionClass. Parameters: encryptionClass - New value of property encryptionClass.

setEncryptionMethod
public void setEncryptionMethod(String encryptionMethod)(Code)
	Setter for property encryptionMethod. Parameters: encryptionMethod - New value of property encryptionMethod.

setRoleNameCol
public void setRoleNameCol(String roleNameCol)(Code)
	Set the column in the user role table that names a role. Parameters: roleNameCol - The column name

setRoleSelect
public void setRoleSelect(String roleSelect)(Code)
	Setter for property roleSelect. This, if set is used as an override for creating the complete prepared statement for retriving the list of roles from the database. Parameters: roleSelect - New value of property roleSelect.

setUserClause
public void setUserClause(String userClause)(Code)
	Setter for property userClause. Parameters: userClause - New value of property userClause.

setUserCredCol
public void setUserCredCol(String userCredCol)(Code)
	Set the column in the user table that holds the user's credentials. Parameters: userCredCol - The column name

setUserNameCol
public void setUserNameCol(String userNameCol)(Code)
	Set the column in the user table that holds the user's name. Parameters: userNameCol - The column name

setUserRoleTable
public void setUserRoleTable(String userRoleTable)(Code)
	Set the table that holds the relation between user's and roles. Parameters: userRoleTable - The table name

setUserTable
public void setUserTable(String userTable)(Code)
	Set the table that holds user data. Parameters: userTable - The table name

start
public void start() throws LifecycleException(Code)
	Prepare for active use of the public methods of this Component. exception: LifecycleException - if this component detects a fatal errorthat prevents it from being started

stop
public void stop() throws LifecycleException(Code)
	Gracefully shut down active use of the public methods of this Component. exception: LifecycleException - if this component detects a fatal errorthat needs to be reported

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.