Configure the CData JDBC Driver for PayPal in a Connection Pool in Tomcat

Ready to get started?

Download for a free trial:

Download Now

Learn more:

PayPal JDBC Driver

Easy-to-use PayPal client enables Java-based applications to easily consume PayPal Transactions, Orders, Sales, Invoices, etc.



Connect to PayPal data from 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 PayPal data from a connection pool in Tomcat.

Connect to PayPal 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.

    The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

    • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
    • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

    See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

    To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

    For testing purposes you can set UseSandbox to true and use sandbox credentials.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.paypal.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/paypal" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.paypal.PayPalDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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