- How to use
- Advanced usage
- JDBC interceptors
- Configuring JDBC interceptors
- Code Example
The Tomcat JDBC Connection Pool
Table of Contents
The JDBC Connection Pool
is a replacement or an alternative to the Apache Commons DBCP
So why do we need a new connection pool?
Here are a few of the reasons:
- Commons DBCP 1.x is single threaded. In order to be thread safe Commons locks the entire pool for short periods during both object allocation and object return. Note that this does not apply to Commons DBCP 2.x.
- Commons DBCP 1.x can be slow. As the number of logical CPUs grows and the number of concurrent threads attempting to borrow or return objects increases, the performance suffers. For highly concurrent systems the impact can be significant. Note that this does not apply to Commons DBCP 2.x.
- Commons DBCP is over 60 classes. tomcat-jdbc-pool core is 8 classes, hence modifications for future requirement will require much less changes. This is all you need to run the connection pool itself, the rest is gravy.
- Commons DBCP uses static interfaces. This means you have to use the
right version for a given JRE version or you may see
- It's not worth rewriting over 60 classes, when a connection pool can be accomplished with a much simpler implementation.
- Tomcat jdbc pool implements the ability retrieve a connection asynchronously, without adding additional threads to the library itself.
- Tomcat jdbc pool is a Tomcat module, it depends on Tomcat JULI, a simplified logging framework used in Tomcat.
- Retrieve the underlying connection using the
- Starvation proof. If a pool is empty, and threads are waiting for a connection, when a connection is returned, the pool will awake the correct thread waiting. Most pools will simply starve.
Features added over other connection pool implementations
- Support for highly concurrent environments and multi core/cpu systems.
- Dynamic implementation of interface, will support
javax.sqlinterfaces for your runtime environment (as long as your JDBC driver does the same), even when compiled with a lower version of the JDK.
- Validation intervals - we don't have to validate every single time we use the connection, we can do this when we borrow or return the connection, just not more frequent than an interval we can configure.
- Run-Once query, a configurable query that will be run only once, when the connection to the database is established. Very useful to setup session settings, that you want to exist during the entire time the connection is established.
- Ability to configure custom interceptors.
This allows you to write custom interceptors to enhance the functionality. You can use interceptors to gather query stats,
cache session states, reconnect the connection upon failures, retry queries, cache query results, and so on.
Your options are endless and the interceptors are dynamic, not tied to a JDK version of a
- High performance - we will show some differences in performance later on
- Extremely simple, due to the very simplified implementation, the line count and source file count are very low, compare with c3p0 that has over 200 source files(last time we checked), Tomcat jdbc has a core of 8 files, the connection pool itself is about half that. As bugs may occur, they will be faster to track down, and easier to fix. Complexity reduction has been a focus from inception.
- Asynchronous connection retrieval - you can queue your request for a connection and receive a
- Better idle connection handling. Instead of closing connections directly, it can still pool connections and sizes the idle pool with a smarter algorithm.
- You can decide at what moment connections are considered abandoned, is it when the pool is full, or directly at a timeout by specifying a pool usage threshold.
- The abandon connection timer will reset upon a statement/query activity. Allowing a connections that is in use for a long time to not timeout.
This is achieved using the
- Close connections after they have been connected for a certain time. Age based close upon return to the pool.
- Get JMX notifications and log entries when connections are suspected for being abandoned. This is similar to
removeAbandonedTimeoutbut it doesn't take any action, only reports the information. This is achieved using the
- Connections can be retrieved from a
javax.sql.XADataSourceThis is achieved using the
- XA connection support
How to use
Usage of the Tomcat connection pool has been made to be as simple as possible, for those of you that are familiar with commons-dbcp, the transition will be very simple. Moving from other connection pools is also fairly straight forward.
The Tomcat connection pool offers a few additional features over what most other pools let you do:
initSQL- the ability to run a SQL statement exactly once, when the connection is created
validationInterval- in addition to running validations on connections, avoid running them too frequently.
jdbcInterceptors- flexible and pluggable interceptors to create any customizations around the pool, the query execution and the result set handling. More on this in the advanced section.
fairQueue- Set the fair flag to true to achieve thread fairness or to use asynchronous connection retrieval
Inside the Apache Tomcat Container
The Tomcat Connection pool is configured as a resource described in The Tomcat JDBC documentation
With the only difference being that you have to specify the
factory attribute and set the value to
The connection pool only has another dependency, and that is on tomcat-juli.jar.
To configure the pool in a stand alone project using bean instantiation, the bean to instantiate is
org.apache.tomcat.jdbc.pool.DataSource. The same attributes (documented below) as you use to configure a connection
pool as a JNDI resource, are used to configure a data source as a bean.
The connection pool object exposes an MBean that can be registered.
In order for the connection pool object to create the MBean, the flag
jmxEnabled has to be set to true.
This doesn't imply that the pool will be registered with an MBean server, merely that the MBean is created.
In a container like Tomcat, Tomcat itself registers the DataSource with the MBean server, the
org.apache.tomcat.jdbc.pool.DataSource object will then register the actual
connection pool MBean.
If you're running outside of a container, you can register the DataSource yourself under any object name you specify,
and it propagates the registration to the underlying pool. To do this you would call
Prior to this call, ensure that the pool has been created by calling
To provide a very simple switch to and from commons-dbcp and tomcat-jdbc-pool, Most attributes are the same and have the same meaning.
JNDI Factory and Type
factory is required, and the value should be
Type should always be
Depending on the type a
System properties are JVM wide, affect all pools created in the JVM
(boolean) Controls classloading of dynamic classes, such as
JDBC drivers, interceptors and validators. If set to
These attributes are shared between commons-dbcp and tomcat-jdbc-pool, in some cases default values are different.
(boolean) The default auto-commit state of connections created by this pool. If not set, default is JDBC driver default (If not set then the
(boolean) The default read-only state of connections created by this pool. If not set then the
(String) The default TransactionIsolation state of connections created by this pool. One of the following: (see javadoc )
If not set, the method will not be called and it defaults to the JDBC driver.
(String) The default catalog of connections created by this pool.
(String) The fully qualified Java class name of the JDBC driver to be used. The driver has to be accessible from the same classloader as tomcat-jdbc.jar
(String) The connection username to be passed to our JDBC driver to establish a connection.
Note that method
(String) The connection password to be passed to our JDBC driver to establish a connection.
Note that method
(int) The maximum number of active connections that can be allocated from this pool at the same time.
The default value is
(int) The maximum number of connections that should be kept in the pool at all times.
Default value is
(int) The minimum number of established connections that should be kept in the pool at all times.
The connection pool can shrink below this number if validation queries fail.
Default value is derived from
(int)The initial number of connections that are created when the pool is started.
Default value is
(int) The maximum number of milliseconds that the pool will wait (when there are no available connections)
for a connection to be returned before throwing an exception.
Default value is
(boolean) The indication of whether objects will be validated before being borrowed from the pool.
If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another.
In order to have a more efficient validation, see
(boolean) The indication of whether objects will be validated when a connection is first created.
If an object fails to validate, it will be throw
(boolean) The indication of whether objects will be validated before being returned to the pool.
The default value is
(boolean) The indication of whether objects will be validated by the idle object evictor (if any).
If an object fails to validate, it will be dropped from the pool.
The default value is
(String) The SQL query that will be used to validate connections