Connect to Clarifai 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 Clarifai 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 Clarifai. You will then access Clarifai data from a connection pool.

Create a JDBC Data Source for Clarifai 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.
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.

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

   Clarifai API Profile Settings

   Clarifai uses Personal Access Tokens (PATs) for authentication. To obtain a PAT:

   1. Log in to your Clarifai account at https://clarifai.com.
   2. Navigate to your profile settings and select Security.
   3. Click Create Personal Access Token.
   4. Select the required scopes and click Create Token.
   5. Copy the generated token (it will only be shown once).

   After obtaining your Personal Access Token, set the following connection properties:

   • AuthScheme: Set this to APIKey.

   Set the following in the ProfileSettings connection property:

   • APIKey: Set this to your Clarifai Personal Access Token (PAT).

   Built-in Connection String Designer

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

   

   A typical connection string is below:

   
   jdbc:api:Profile=C:\profiles\Clarifai.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_access_token';
   

7. Test the connection and finish the wizard. Select the Clarifai 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.