Configure the CData JDBC Driver for Adobe Commerce 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 Adobe Commerce data from a connection pool in Tomcat.

Connect to Adobe Commerce 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.

   Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

   You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

   • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

   • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

     If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.adobe commerce.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/adobe commerce" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.adobe commerce.Adobe CommerceDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

   To allow a single application to access Adobe Commerce 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 Adobe Commerce for all applications.

3. Add a reference to the resource to the web.xml for the application. Adobe Commerce data JSP jdbc/Adobe Commerce 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/Adobe Commerce"); Connection conn = ds.getConnection();

More Tomcat Integration

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