DBCP Overview
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8a57eb16-f469-4834-8bb5-65dc60f0ec2b"><ac:plain-text-body><![CDATA[ {{ http://jakarta.apache.org/commons/dbcp/images/dbcp-logo-white.png}} | Commons-DBCP provides database [http://jakarta.apache.org/commons/dbcp/ Commons-DBCP] provides database connection pooling services.[BR] | ]]></ac:plain-text-body></ac:structured-macro> |
Release Plans
External Resources
Here's a little diagram showing what datastructure DBCP sets up and how that datastructure is used in case the DriverManager is employed to obtain Drivers at runtime. Please send any corrections (for now) to d.tonhofer@m-plify.com.
- Apache_DBCP_Structure.pdf
\[http://public.m-plify.net/Apache_DBCP/Apache_DBCP_Structure.pdf vsdWiki Markup - Apache_DBCP_Structure.pdf\]
\[pngWiki Markup
Diagrams hosted by http://public.m-plify.net
...
The Database Connection Pool (DBCP) component can be used in applications where JDBC resources need to be pooled. Apart from JDBC connections, this provides support for pooling Statement and PreparedStatement instances as well. Complete article can be found here http://www.devx.com/Java/Article/29795/0/page/2.
Security Manager settings
If you're running tomcat with the Security Manager, you will need to add to your catalina.policy:
No Format |
---|
grant {
|
...
Wiki Markup |
---|
\[http://public.m-plify.net/Apache_DBCP/Apache_DBCP_Structure.png Apache_DBCP_Structure.png\]
\\ |
Diagrams hosted by http://public.m-plify.net
The Database Connection Pool (DBCP) component can be used in applications where JDBC resources need to be pooled. Apart from JDBC connections, this provides support for pooling Statement and PreparedStatement instances as well. Complete article can be found here http://www.devx.com/Java/Article/29795/0/page/2.
Security Manager settings
Wiki Markup |
---|
If you're running tomcat with the \[http://tomcat.apache.org/tomcat-5.5-doc/security-manager-howto.html Security Manager\], you will need to add to your catalina.policy: |
No Format |
---|
grant {
permission java.lang.RuntimePermission "accessClassInPackage.org.apache.tomcat.dbcp.*";
};
|
...
Tomcat 5.0 Configuration examples
Some Tomcat JNDI Datasource examples (in addition to the \[http://tomcat.apache.org/tomcat-6.0-doc/jndi-datasource-examples-howto.html Tomcat 6.0 JNDI datasource howto\]Some Tomcat JNDI Datasource examples (in addition to the Tomcat 5.5 JNDI datasource howto). Wiki Markup
BasicDataSource
No Format |
---|
<Resource name="jdbc/abandoned" auth="Container" type="javax.sql.DataSource"/> <ResourceParams name="jdbc/abandoned"> <parameter><name>factory</name><value>org.apache.commons.dbcp.BasicDataSourceFactory</value></parameter> <parameter><name>username</name><value>sa</value></parameter> <parameter><name>password</name><value></value></parameter> <parameter><name>driverClassName</name><value>org.hsqldb.jdbcDriver</value></parameter> <parameter><name>url</name><value>jdbc:hsqldb:database</value></parameter> <parameter><name>removeAbandoned</name><value>false</value></parameter> <parameter><name>removeAbandonedTimeout</name><value>300</value></parameter> <parameter><name>logAbandoned</name><value>true</value></parameter> <parameter><name>maxActive</name><value>10</value></parameter> </ResourceParams> |
...
2: Saying what class will actually create instances of the above, i.e. give the factory. This is actually not necessary if you want 'org.apache.commons.dbcp.BasicDataSourceFactory' as that is the default factory used by Tomcat whenever 'javax.sql.DataSource' objects should be created. By setting 'factory', you can override that default value. 'o.a.c.d.BasicDataSourceFactory' creates 'org.apache.commons.dbcp.BasicDataSource' instances. These use a resource pool of type 'org.apache.commons.pool.impl.GenericObjectPool'. And for this type of pool we can demand that objects be verified at borrowing time - which is what we want as it will prevent Tomcat getting its paws on stale database connections.
*3*: Configuring the attributes of the 'BasicDataSourceFactory'. The allowed attributes can be found by looking for JavaBean-compliant set() methods and members in the source or the
\[http://jakarta.apache.org/commons/dbcp/apidocs/index.html DBCP API doc\]. In particular: what driver shall be used by the factory to actually get database connections: 'com.mysql.jdbc.Driver'. Wiki Markup
Additionally (and one level down, if you will) the 'Driver' named in '!driverClassName' is itself configured through the URL used when a new connection is created
I have put the 'Resource' element into the 'GlobalNamingResource' element instead of the 'Context' element. If you want to put it in the 'Context' element, the 'Realm' must be in the same 'Context' element and must additionally have the attribute 'localDataSource' set to 'true'.
- Tomcat 5.5 'server' element configuration.
- Tomcat
\[http://jakarta.apache.org/tomcat/tomcat- 5.5 -doc/config/server.html Tomcat 5.5 'server' element configuration\].Wiki Markup Wiki Markup \[http://jakarta.apache.org/tomcat/tomcat-5.5-doc/jndi-datasource-examples-howto.html Tomcat 5.5 JNDI-DataSource examples\]
Wiki Markup \[http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/context.html#Resource%20Definitions The definition of 'resource'\]
Wiki Markup \[http://jakarta.apache.org/tomcat/tomcat-4.1-doc/jndi-resources-howto.html Tomcat 4.1 JDNI resources howto\] \\
- JNDI-DataSource examples
- The definition of 'resource'
- Tomcat 4.1 JDNI resources howto
No Format |
---|
<Server ...>
<GlobalNamingResources>
<Resource name="jdbc/mydatabase"
auth="Container"
type="javax.sql.DataSource |
No Format |
<Server ...> <GlobalNamingResources> <Resource name="jdbc/mydatabase" auth="Container" type="javax.sql.DataSource" factory="factory="org.apache.commons.dbcp.BasicDataSourceFactory" driverClassName="com.mysql.jdbc.Driver" validationQuery="SELECT 1" loginTimeout="10" maxWait="5000" username="i_am_tomcat" password="my_password_is_foo" testOnBorrow="true" url="jdbc:mysql://127.0.0.1/mydatabase?connectTimeout=5000&socketTimeout=8000&useUsageAdvisor=true" /> </GlobalNamingResources> ...something something... </Server> |
...
The Realm implementation is 'org.apache.catalina.realm.DataSourceRealm'; it will use a 'javax.sql.DataSource' interface found in the JNDI initial context. The location of that interface inside the JNDI namespace is given by 'dataSourceName': 'java:com/env/jdbc/mydatabase'.
Wiki Markup \[http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/realm.html Tomcat 5.5 Realm configuration\]
Wiki Markup \[http://jakarta.apache.org/tomcat/tomcat-5.5-doc/realm-howto.html#DataSourceRealm Tomcat 5.5 DataSourceRealm\] \\
No Format |
---|
<Host ....>
<Context ...> ... </Context>
<Context ... |
No Format |
<Host ....> <Context ...> ... </Context> <Context ...> ... </Context> <Realm className="org.apache.catalina.realm.DataSourceRealm" dataSourceName="jdbc/mydatabase" digest="MD5" roleNameCol="web_user_role_name" userCredCol="account_md5_password" userNameCol="account_login" userRoleTable="web_user_role_t" userTable="account_t" /> </Host> |
Finally, beware \[http://issues.apache.org/bugzilla/show_bug.cgi?id=33357 bug 33357\] in Finally, beware bug 33357 in 5.5.7 which should be fixed soon though :-P Wiki Markup
Hibernate
\[http://www.hibernate.org/ Hibernate\] is a powerful, ultra-high performance object/relational persistence and query service for Java. Hibernate lets you develop persistent classes following common Java idiom - including association, inheritance, polymorphism, composition and the Java collections framework. Wiki Markup
\[:DBCP/Hibernate\] configuration \\Wiki Markup
FAQ
Q: Is this project still active or have they just not released anything in an excessive period of time?
...
The following links are of use for the discussion::
- org.apache.commons.pool.PoolableObjectFactory.validateObject(java.lang.Object)
- org.apache.commons.dbcp.PoolableConnectionFactory
Wiki Markup \[http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/PoolableObjectFactory.html#validateObject(java.lang.Object) org.apache.commons.pool.PoolableObjectFactory.validateObject(java.lang.Object)\]
Wiki Markup \[http://jakarta.apache.org/commons/dbcp/apidocs/org/apache/commons/dbcp/PoolableConnectionFactory.html org.apache.commons.dbcp.PoolableConnectionFactory\]
Wiki Markup \[http://jakarta.apache.org/commons/dbcp/apidocs/org/apache/commons/dbcp/PoolableConnectionFactory.html#validateConnection(java.sql.Connection) org.apache.commons.dbcp.PoolableConnectionFactory.validateConnection(java.sql.Connection)\]
\[http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/StackObjectPool.html org.apache.commons.pool.StackObjectPool\]Wiki Markup \[http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/GenericObjectPool.html dbcp.PoolableConnectionFactory.validateConnection(java.sql.Connection)Wiki Markup - org.apache.commons.pool.StackObjectPool
- org.apache.commons.pool.GenericObjectPool\]
\\
Q: What is "Validation of Connections"?
...
There is a 'autoReconnectForPools' starting from MySQL-Connector-J which I haven't looked into yet. unmigrated-wiki-markup
See \[http://dev.mysql.com/doc/connector/j/en/index.html#id2425656 Connector-J Connection Properties\] for additional details, and also the source for _com.mysql.jdbc.Connection.execSQL()_.