Connect to PingOne Data from a Connection Pool in Jetty

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

   <Configure id='pingonedemo' class="org.eclipse.jetty.webapp.WebAppContext">
    <New id="pingonedemo" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg><Ref refid="pingonedemo"/></Arg>
    <Arg>jdbc/pingonedb</Arg>
    <Arg>
    <New class="cdata.jdbc.pingone.PingOneDriver">
    <Set name="url">jdbc:pingone:</Set>
    <Set name="AuthScheme">OAuth</Set>
    <Set name="WorkerAppEnvironmentId">eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e</Set>
    <Set name="Region">NA</Set>
    <Set name="OAuthClientId">client_id</Set>
    <Set name="OAuthClientSecret">client_secret</Set>
    <Set name="InitiateOAuth">GETANDREFRESH</Set>
    </New>
    </Arg>
    </New>
   </Configure>
   

   To connect to PingOne, configure these properties:

   • : The region where the data for your PingOne organization is being hosted.
   • : The type of authentication to use when connecting to PingOne.
   • Either (required when using the default PingOne domain) or , configured as described below.

   Configuring WorkerAppEnvironmentId

   is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.

   First, find the value for this property:

   1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
   2. Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
   3. In the environment's home page navigation sidebar, click Applications.
   4. Find your OAuth or Worker application details in the list.
   5. Copy the value in the Environment ID field. It should look similar to:
      

      WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

   Now set to the value of the Environment ID field.

   Configuring AuthorizationServerURL

   is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.

   Authenticating to PingOne with OAuth

   PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:

   • Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
   • To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
   • Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.

   OAuth (Authorization Code grant)

   Set to OAuth.

   Desktop Applications

   Get and Refresh the OAuth Access Token

   After setting the following, you are ready to connect:

   • : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
   • : The Client ID you obtained when you created your custom OAuth application.
   • : The Client Secret you obtained when you created your custom OAuth application.
   • : The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333

   When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

   1. The driver obtains an access token from PingOne and uses it to request data.
   2. The OAuth values are saved in the location specified in , to be persisted across connections.

   The driver refreshes the access token automatically when it expires.

   For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.

4. Configure the resource in the Web.xml:

    jdbc/pingonedb
    javax.sql.DataSource
    Container
   
   

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

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

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.