Wednesday, January 18, 2017

How to setup JNDI Database Connection pool in Tomcat - Spring Tutorial Example

Setting JNDI Database Connection pool in Spring and Tomcat is pretty easy. Tomcat server documentation gives enough information on how to setup connection pool in Tomcat 5, 6 or 7. Here we will use Tomcat 7 along with spring framework for creating a connection pool in Tomcat server and accessing them in Spring using JNDI code. In our last article, we have seen how to setup database connection pool in Spring for core Java application which doesn't run on web server or application server and doesn't have managed J2EE container. but if you are developing web application than its better to use server managed connection pool and access them using JNDI. Spring configuration will be generic and just based on JNDI name of Datasource so it will work on any J2EE Server e.g. glassfish, WebLogic, JBoss or WebSphere until JNDI name is same. Tomcat is my favorite web server and I use it a lot on development and its comes integrated with IDE like Eclipse and Netbeans. I am using it for all test and development purpose, Though beware with java.lang.OutOfMemoryError: PermGen space in tomcat,

How to use JNDI database connection pool in Tomcat and Spring

There three steps to configure and run JNDI Datasource Connection pool for any  Java Web application:
1) Configure data source in Server and create JNDI name.
2) Configure web.xml
3) Configure Spring bean with JNDI Datasource
4) Include JDBC driver library on Server lib

In order to create JNDI DataSource on J2EE web server you need to follow server documentation. On Tomcat 6 you can simply put following piece of XML in context.xml to create Tomcat managed database connection pool:

<?xml version="1.0" encoding="UTF-8"?>
<Context antiJARLocking="true" path="/springDataSourceDemo">
<Resource name="jdbc/springeDataSource"

JNDI Database connection pool in Tomcat and access SpringResource element will create JNDI data source which can be referenced using JNDI name "jdbc/springeDataSource". Tomcat internally use DBCP and Commons pool library for managing database connection pool. you can check tomcat/lib directory  for jar file tomcat-dbcp.jar which is responsible for creating database connection pool inside tomcat server.

web.xml configuration to access JNDI Database connection pool
In order to access any server resource from your web application, you need to specify JNDI resources in web.xml. you
can use the following XML to declare JNDI Datasource in web.xml:

        <description>Oracle Spring JNDI Datasource</description>

Now your web application will see JNDI Datasource created in tomcat with name jdbc/springDataSource.

Spring configuration for accessing JNDI Datasource :
This spring configuration is generic enough which can be used to access any JNDI data source deployed on any J2EE Server. It’s not tied up with Tomcat. org.springframework.jndi.JndiObjectFactoryBean is used to lookup JNDI Datasource and bind with javax.sql.DataSource.

<bean id="springDataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
  <property name="jndiName" value="java:comp/env/jdbc/springDataSource"/>
  <property name="lookupOnStartup" value="true"/>
  <property name="proxyInterface" value="javax.sql.DataSource"/>

Now the final step is to make sure tomcat lib has JDBC driver jar file. I usually put JAR file inside lib directory of tomcat but you can put it anywhere it make sense and modify tomcat classpath to include driver JAR into classpath. Now rest of code which uses this datasource should remain same. You can get Spring DAO source from the previous article How to setup Database Connection pool in Spring framework.

Further Reading
Spring Master Class - Beginner to Expert
Introduction to Spring MVC 4 By Bryan Hansen
Spring and Hibernate for Beginners
Spring in Action 4th edition by Craig Walls

Other Spring Framework Tutorials from Javarevisited blog

P.S. - If you want to learn how to develop RESTful Web Service using Spring MVC in depth, I suggest you join the REST with Spring certification class by Eugen Paraschiv. One of the best course to learn REST with Spring MVC. 

1 comment :

Abirami R said...

I got the idea aout database connection with pool in tomcat...its easy to understand

Post a Comment