Connect to Zuora Data from a Connection Pool in Jetty

The CData JDBC driver for Zuora is easy to integrate with Java Web applications. This article shows how to efficiently connect to Zuora data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for Zuora in Jetty.

Configure the JDBC Driver for Salesforce as a JNDI Data Source

Follow the steps below to connect to Salesforce from Jetty.

1. Enable the JNDI module for your Jetty base. The following command enables JNDI from the command-line:

   java -jar ../start.jar --add-to-startd=jndi
   

2. Add the CData and license file, located in the lib subfolder of the installation directory, into the lib subfolder of the context path.

3. Declare the resource and its scope. Enter the required connection properties in the resource declaration. This example declares the Zuora data source at the level of the Web app, in WEB-INF\jetty-env.xml.

   <Configure id='zuorademo' class="org.eclipse.jetty.webapp.WebAppContext">
    <New id="zuorademo" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg><Ref refid="zuorademo"/></Arg>
    <Arg>jdbc/zuoradb</Arg>
    <Arg>
    <New class="cdata.jdbc.zuora.ZuoraDriver">
    <Set name="url">jdbc:zuora:</Set>
    <Set name="OAuthClientID">MyOAuthClientId</Set>
    <Set name="OAuthClientSecret">MyOAuthClientSecret</Set>
    <Set name="Tenant">USProduction</Set>
    <Set name="ZuoraService">DataQuery</Set>
    <Set name="InitiateOAuth">GETANDREFRESH</Set>
    </New>
    </Arg>
    </New>
   </Configure>
   

   Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

   Configuring Tenant property

   In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

   • USProduction: Requests sent to https://rest.zuora.com.
   • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
   • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
   • EUProduction: Requests sent to https://rest.eu.zuora.com"
   • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

   Selecting a Zuora Service

   Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

   DataQuery

   The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

   Limitations
   • The maximum number of input records per table after filters have been applied: 1,000,000
   • The maximum number of output records: 100,000
   • The maximum number of simultaneous queries submitted for execution per tenant: 5
   • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
   • The maximum processing time for each query in hours: 1
   • The maximum size of memory allocated to each query in GB: 2
   • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

   AQuADataExport

   AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

   Limitations
   • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
   • The killed AQuA job can be retried three times before returned as failed.

4. Configure the resource in the Web.xml:

    jdbc/zuoradb
    javax.sql.DataSource
    Container
   
   

5. You can then access Zuora with a lookup to java:comp/env/jdbc/zuoradb:

   InitialContext ctx = new InitialContext();
   DataSource myzuora = (DataSource)ctx.lookup("java:comp/env/jdbc/zuoradb");
   

More Jetty Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more use cases and information, see the Working with Jetty JNDI chapter in the Jetty documentation.