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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Factorial 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 Factorial data from a connection pool in Tomcat.

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

    Authentication

    Factorial uses OAuth 2.0 for authentication to connect to your HR data or to allow other users to connect to their data.

    Using OAuth Authentication

    To connect using OAuth, follow these steps:

    1. Navigate to your Factorial admin panel and create a new OAuth application.
    2. Copy the Client ID and Client Secret from your application configuration.
    3. Configure the following connection properties:

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to your OAuth Client ID.
    • OAuthClientSecret: Set this to your OAuth Client Secret.
    • Scope: Set this to specify the data access permissions (default: "read write").

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.api.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/api"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:api:Profile=C:\profiles\Factorial.apip;AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;" maxActive="20" maxIdle="10" maxWait="-1" />
    

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

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

More Tomcat Integration

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

Ready to get started?

Connect to live data from Factorial with the API Driver

Connect to Factorial