Connect to Onfleet Data from a Connection Pool in JBoss

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Onfleet data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Onfleet. You will then access Onfleet data from a connection pool.

Create a JDBC Data Source for Onfleet from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable. 👁 The deployed JAR. (Salesforce is shown.)
   
3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example:

   java:jboss/root/jdbc/API

5. Select the driver that you added above.

6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:api: followed by a semicolon-separated list of connection properties.

   Onfleet uses HTTP ApiKey Authentication. Your Onfleet API Key is used to authenticate requests. You can generate or view your API Key in the Onfleet dashboard under Settings > API.

   Using ApiKey Authentication

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Onfleet API Key.

   Example connection string:

   Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Onfleet 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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   A typical connection string is below:

   jdbc:api:Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";
   

7. Test the connection and finish the wizard. Select the Onfleet data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.