SpringBoot JNDI datasource throws java.lang.ClassNotFoundException: org.apache.tomcat.dbcp.dbcp2.BasicDataSourceFactory
I solved the problem by setting factory
attribute in my Resource
Definition. resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
@Bean
public TomcatEmbeddedServletContainerFactory embeddedServletContainerFactory(){
return new TomcatEmbeddedServletContainerFactory() {
@Override
protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
Tomcat tomcat) {
tomcat.enableNaming();
return super.getTomcatEmbeddedServletContainer(tomcat);
}
@Override
protected void postProcessContext(Context context) {
ContextResource resource = new ContextResource();
resource.setName("jdbc/myDataSource");
resource.setType(DataSource.class.getName());
resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
resource.setProperty("driverClassName", "com.ibm.db2.jcc.DB2Driver");
resource.setProperty("url", "url");
resource.setProperty("username", "user");
resource.setProperty("password", "*****");
context.getNamingResources().addResource(resource);
}
};
}
As per tomcat 8 documentation, it is supposed to automatically infer db pool factory type by looking at DataSource
type and somehow it defaults to DBCP factory and that class is not there in my class path.
I guess so issue can be solved by making tomcat-dbcp-**
jars available but I am not sure how to do that with spring boot or even if that is possible with spring boot.
What I find weird is Spring Boot not including tomcat-dbcp dependencies as part of starter POM but using DBCP DataSource factory as default factory.
The “Starter POM” no longer includes jndi reltead dependencies, if you are using Tomcat/Jetty/etc... with JNDI you will now need to directly add this dependency yourself.
Then configure the JNDI in your application.properties file
spring.datasource.jndi-name=java:comp/env/jdbc/yourname
For your exception, you need add the tomcat-dbcp into your pom.xml file.
But you can check your project dependencies, if you use the spring-boot-starter-jdbc or spring-boot-starter-data-jpa ‘starters’ you will automatically get a dependency to "tomcat-jdbc".
You have multiple choices :
- using the DBCP 2 datasource that is the default (you don't want to use DBCP 1 that is outdated and less efficient).
- using the Tomcat JDBC datasource.
- using any other datasource : for example HikariCP.
1) To use Apache JDBC datasource, you don't need to add any dependency as it is already provided in the Tomcat Spring Boot starter but you have to change the default factory class to org.apache.tomcat.jdbc.pool.DataSourceFactory
to use it.
You can do it in the resource declaration :
resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
I will explain below where add this line.
2) To use DBCP 2 datasource (which is actually expected by default) a dependency is required:
<dependency>
<groupId>org.apache.tomcat</groupId>
<artifactId>tomcat-dbcp</artifactId>
<version>8.5.4</version>
</dependency>
Of course, adapt the artifact version according to your Spring Boot Tomcat embedded version.
3) To use any other datasource, I will illustrate with HikariCP, add the required dependency if not already present in your configuration (it may be for HikariCP if you rely on persistence starters of Spring Boot) such as :
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.1.0</version>
</dependency>
and specify the factory that goes with in the resource declaration :
resource.setProperty("factory", "com.zaxxer.hikari.HikariDataSource");
For example with PostgreSQL and a DBCP 2 datasource, don't specify any factory as it is the default :
@Override
protected void postProcessContext(Context context) {
ContextResource resource = new ContextResource();
//...
context.getNamingResources()
.addResource(resource);
}
Here the variants for Tomcat JDBC and HikariCP datasource.
In postProcessContext()
set the factory property as explained early for Tomcat JDBC ds :
@Override
protected void postProcessContext(Context context) {
ContextResource resource = new ContextResource();
//...
resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
//...
context.getNamingResources()
.addResource(resource);
}
};
and for HikariCP :
@Override
protected void postProcessContext(Context context) {
ContextResource resource = new ContextResource();
//...
resource.setProperty("factory", "com.zaxxer.hikari.HikariDataSource");
//...
context.getNamingResources()
.addResource(resource);
}
};