Configure the CData JDBC Driver for IBM Cloud Data Engine in a Connection Pool in Tomcat

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to IBM Cloud Data Engine data from a connection pool in Tomcat.

Connect to IBM Cloud Data Engine Data through a Connection Pool in Tomcat

1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
2. Add a definition of the resource to the context. Specify the JDBC URL here.

   IBM Cloud Data Engine uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the IBM Cloud Data Engine JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.ibmclouddataengine.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   You can see the JDBC URL specified in the resource definition below.

   <Resource name="jdbc/ibmclouddataengine" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.ibmclouddataengine.IBMCloudDataEngineDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:ibmclouddataengine:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

   To allow a single application to access IBM Cloud Data Engine data, add the code above to the context.xml in the application's META-INF directory.

   For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to IBM Cloud Data Engine for all applications.

3. Add a reference to the resource to the web.xml for the application. IBM Cloud Data Engine data JSP jdbc/IBMCloudDataEngine javax.sql.DataSource Container
4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/IBMCloudDataEngine"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to IBM Cloud Data Engine data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.