Connect to Placid 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 Placid 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 Placid. You will then access Placid data from a connection pool.
Create a JDBC Data Source for Placid from the Management Console
Follow the steps below to add the driver JAR and define required connection properties.
- 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.
- 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.
- In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
- Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example:
java:jboss/root/jdbc/API
- Select the driver that you added above.
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.
Placid uses API Key authentication to control access to the API. API tokens are project-specific and can be obtained from your project settings on placid.app.
Using API Key Authentication
To obtain your API key, log in to placid.app, navigate to your project, open the project settings, and generate an API token from the API section. Note that each API token is scoped to a specific project.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Placid project API token.
Example connection string:
Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Placid 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\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
- Test the connection and finish the wizard. Select the Placid 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.