Connect to ApprovalMax Data from a Connection Pool in Jetty

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
The ApprovalMax JDBC Driver supports connection pooling: This article shows how to connect faster to ApprovalMax data from Web apps in Jetty.

The CData JDBC driver for ApprovalMax is easy to integrate with Java Web applications. This article shows how to efficiently connect to ApprovalMax data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for ApprovalMax 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 ApprovalMax data source at the level of the Web app, in WEB-INF\jetty-env.xml.

    
    
    <Configure id='approvalmaxdemo' class="org.eclipse.jetty.webapp.WebAppContext">
        <New id="approvalmaxdemo" class="org.eclipse.jetty.plus.jndi.Resource">
        <Arg><Ref refid="approvalmaxdemo"/></Arg>
        <Arg>jdbc/approvalmaxdb</Arg>
        <Arg>
          <New class="cdata.jdbc.api.APIDriver">
            <Set name="url">jdbc:api:</Set>
            <Set name="Profile">C:\profiles\ApprovalMax.apip</Set>
            <Set name="AuthScheme">OAuth</Set>
            <Set name="InitiateOAuth">GETANDREFRESH</Set>
            <Set name="OAuthClientId">your_client_id</Set>
            <Set name="OAuthClientSecret">your_client_secret</Set>
            <Set name="CallbackURL">your_callback_url</Set>
          </New>
        </Arg>
      </New>
    </Configure>
    

    Start by setting the Profile connection property to the location of the ApprovalMax Profile on disk (e.g. C:\profiles\ApprovalMax.apip). Next, set the ProfileSettings connection property to the connection string for ApprovalMax (see below).

    ApprovalMax API Profile Settings

    To authenticate to ApprovalMax and connect to your own data or to allow other users to connect to their data, the ApprovalMax Public API requires the OAuth 2.0 authorization code flow.

    First, you will need to register an OAuth application with ApprovalMax. Sign in to the ApprovalMax Developer Portal (https://developer.approvalmax.com/applications) and create a new application. Your OAuth application will be assigned a Client ID and a Client Secret, and you must register at least one Redirect URI (Callback URL).

    A Premium ApprovalMax subscription (or active trial) is required to use the Public API.

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

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
    • OAuthClientId: Set this to the Client ID that is shown in your application settings on the ApprovalMax Developer Portal.
    • OAuthClientSecret: Set this to the Client Secret that is shown in your application settings on the ApprovalMax Developer Portal.
    • CallbackURL: Set this to the Redirect URI that is registered in your application settings.
    • Scope: (Optional) Override the default OAuth scopes. The default value openid offline_access https://www.approvalmax.com/scopes/public_api/read grants read-only access to all tables in this profile and enables refresh tokens. Use the principle of least privilege when narrowing this scope.

    The OAuth Authorization URL is https://identity.approvalmax.com/connect/authorize and the Token URL is https://identity.approvalmax.com/connect/token. Both authorization_code and refresh_token grant types are supported.

  4. Configure the resource in the Web.xml:

    
    
      jdbc/approvalmaxdb
      javax.sql.DataSource
      Container
    
    
  5. You can then access ApprovalMax with a lookup to java:comp/env/jdbc/approvalmaxdb:

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

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.

Ready to get started?

Connect to live data from ApprovalMax with the API Driver

Connect to ApprovalMax