Java Doc for JDBCRealm.java in  » Sevlet-Container » tomcat-catalina » org » apache » catalina » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » Sevlet Container » tomcat catalina » org.apache.catalina.realm 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.catalina.realm.RealmBase
      org.apache.catalina.realm.JDBCRealm

JDBCRealm
public class JDBCRealm extends RealmBase (Code)
Implmentation 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.

TODO - Support connection pooling (including message format objects) so that authenticate() does not have to be synchronized and would fix the ugly connection logic.


author:
   Craig R. McClanahan
author:
   Carson McDonald
author:
   Ignacio Ortega
version:
   $Revision: 1.7 $ $Date: 2004/05/26 15:51:08 $


Field Summary
protected  StringconnectionName
     The connection username to use when trying to connect to the database.
protected  StringconnectionPassword
     The connection URL to use when trying to connect to the database.
protected  StringconnectionURL
     The connection URL to use when trying to connect to the database.
protected  ConnectiondbConnection
     The connection to the database.
protected  Driverdriver
     Instance of the JDBC Driver class we use as a connection factory.
protected  StringdriverName
     The JDBC driver to use.
final protected static  Stringinfo
     Descriptive information about this Realm implementation.
final protected static  Stringname
     Descriptive information about this Realm implementation.
protected  PreparedStatementpreparedCredentials
     The PreparedStatement to use for authenticating users.
protected  PreparedStatementpreparedRoles
     The PreparedStatement to use for identifying the roles for a specified user.
protected  StringroleNameCol
    
final protected static  StringManagersm
     The string manager for this package.
protected  StringuserCredCol
    
protected  StringuserNameCol
    
protected  StringuserRoleTable
    
protected  StringuserTable
     The table that holds user data.


Method Summary
public synchronized  Principalauthenticate(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).
public synchronized  Principalauthenticate(Connection dbConnection, String username, String credentials)
     Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
protected  voidclose(Connection dbConnection)
     Close the specified database connection.
protected  PreparedStatementcredentials(Connection dbConnection, String username)
     Return a PreparedStatement configured to perform the SELECT required to retrieve user credentials for the specified username.
public  StringgetConnectionName()
     Return the username to use to connect to the database.
public  StringgetConnectionPassword()
     Return the password to use to connect to the database.
public  StringgetConnectionURL()
     Return the URL to use to connect to the database.
public  StringgetDriverName()
     Return the JDBC driver that will be used.
protected  StringgetName()
     Return a short name for this Realm implementation.
protected  StringgetPassword(String username)
     Return the password associated with the given principal's user name.
protected  PrincipalgetPrincipal(String username)
     Return the Principal associated with the given user name.
public  StringgetRoleNameCol()
     Return the column in the user role table that names a role.
public  StringgetUserCredCol()
     Return the column in the user table that holds the user's credentials.
public  StringgetUserNameCol()
     Return the column in the user table that holds the user's name.
public  StringgetUserRoleTable()
     Return the table that holds the relation between user's and roles.
public  StringgetUserTable()
     Return the table that holds user data..
protected  Connectionopen()
     Open (if necessary) and return a database connection for use by this Realm.
protected  voidrelease(Connection dbConnection)
     Release our use of this connection so that it can be recycled.
protected  PreparedStatementroles(Connection dbConnection, String username)
     Return a PreparedStatement configured to perform the SELECT required to retrieve user roles for the specified username.
public  voidsetConnectionName(String connectionName)
     Set the username to use to connect to the database.
public  voidsetConnectionPassword(String connectionPassword)
     Set the password to use to connect to the database.
public  voidsetConnectionURL(String connectionURL)
     Set the URL to use to connect to the database.
public  voidsetDriverName(String driverName)
     Set the JDBC driver that will be used.
public  voidsetRoleNameCol(String roleNameCol)
     Set the column in the user role table that names a role.
public  voidsetUserCredCol(String userCredCol)
     Set the column in the user table that holds the user's credentials.
public  voidsetUserNameCol(String userNameCol)
     Set the column in the user table that holds the user's name.
public  voidsetUserRoleTable(String userRoleTable)
     Set the table that holds the relation between user's and roles.
public  voidsetUserTable(String userTable)
     Set the table that holds user data.
public  voidstart()
     Prepare for active use of the public methods of this Component.
public  voidstop()
     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.



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 synchronized 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



authenticate
public synchronized Principal authenticate(Connection dbConnection, String username, String credentials) throws SQLException(Code)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
Parameters:
  dbConnection - The database connection to be used
Parameters:
  username - Username of the Principal to look up
Parameters:
  credentials - Password or other credentials to use inauthenticating this username
exception:
  SQLException - if a database error occurs



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



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



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



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



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



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



getPassword
protected String getPassword(String username)(Code)
Return the password associated with the given principal's user name.



getPrincipal
protected Principal getPrincipal(String username)(Code)
Return the Principal associated with the given user name.



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



getUserCredCol
public String getUserCredCol()(Code)
Return the 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.



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



getUserTable
public String getUserTable()(Code)
Return the 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.
exception:
  SQLException - if a database error occurs



release
protected void release(Connection dbConnection)(Code)
Release our use of this connection so that it can be recycled.
Parameters:
  dbConnection - The connection to be released



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



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



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



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



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



Fields inherited from org.apache.catalina.realm.RealmBase
protected Container container(Code)(Java Doc)
protected ObjectName controller(Code)(Java Doc)
protected int debug(Code)(Java Doc)
protected String digest(Code)(Java Doc)
protected String domain(Code)(Java Doc)
protected String host(Code)(Java Doc)
final protected static String info(Code)(Java Doc)
protected boolean initialized(Code)(Java Doc)
protected LifecycleSupport lifecycle(Code)(Java Doc)
protected MessageDigest md(Code)(Java Doc)
final protected static MD5Encoder md5Encoder(Code)(Java Doc)
protected static MessageDigest md5Helper(Code)(Java Doc)
protected MBeanServer mserver(Code)(Java Doc)
protected ObjectName oname(Code)(Java Doc)
protected String path(Code)(Java Doc)
protected static StringManager sm(Code)(Java Doc)
protected boolean started(Code)(Java Doc)
protected PropertyChangeSupport support(Code)(Java Doc)
protected String type(Code)(Java Doc)
protected boolean validate(Code)(Java Doc)

Methods inherited from org.apache.catalina.realm.RealmBase
final public static String Digest(String credentials, String algorithm)(Code)(Java Doc)
public void addLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public Principal authenticate(String username, String credentials)(Code)(Java Doc)
public Principal authenticate(String username, byte[] credentials)(Code)(Java Doc)
public Principal authenticate(String username, String clientDigest, String nOnce, String nc, String cnonce, String qop, String realm, String md5a2)(Code)(Java Doc)
public Principal authenticate(X509Certificate certs)(Code)(Java Doc)
public void destroy()(Code)(Java Doc)
protected String digest(String credentials)(Code)(Java Doc)
public LifecycleListener[] findLifecycleListeners()(Code)(Java Doc)
public SecurityConstraint[] findSecurityConstraints(HttpRequest request, Context context)(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public ObjectName getController()(Code)(Java Doc)
public int getDebug()(Code)(Java Doc)
public String getDigest()(Code)(Java Doc)
protected String getDigest(String username, String realmName)(Code)(Java Doc)
public String getDomain()(Code)(Java Doc)
public String getInfo()(Code)(Java Doc)
abstract protected String getName()(Code)(Java Doc)
public ObjectName getObjectName()(Code)(Java Doc)
abstract protected String getPassword(String username)(Code)(Java Doc)
abstract protected Principal getPrincipal(String username)(Code)(Java Doc)
public String getType()(Code)(Java Doc)
public boolean getValidate()(Code)(Java Doc)
protected boolean hasMessageDigest()(Code)(Java Doc)
public boolean hasResourcePermission(HttpRequest request, HttpResponse response, SecurityConstraint[] constraints, Context context) throws IOException(Code)(Java Doc)
public boolean hasRole(Principal principal, String role)(Code)(Java Doc)
public boolean hasUserDataPermission(HttpRequest request, HttpResponse response, SecurityConstraint[] constraints) throws IOException(Code)(Java Doc)
public void init()(Code)(Java Doc)
protected void log(String message)(Code)(Java Doc)
protected void log(String message, Throwable throwable)(Code)(Java Doc)
public static void main(String args)(Code)(Java Doc)
public void postDeregister()(Code)(Java Doc)
public void postRegister(Boolean registrationDone)(Code)(Java Doc)
public void preDeregister() throws Exception(Code)(Java Doc)
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)(Java Doc)
public void removeLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public void setContainer(Container container)(Code)(Java Doc)
public void setController(ObjectName controller)(Code)(Java Doc)
public void setDebug(int debug)(Code)(Java Doc)
public void setDigest(String digest)(Code)(Java Doc)
public void setValidate(boolean validate)(Code)(Java Doc)
public void start() throws LifecycleException(Code)(Java Doc)
public void stop() throws LifecycleException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.