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

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

   To authenticate to ZohoRecruit, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

   Using OAuth Authentication

   First, you will need to register an OAuth application with ZohoRecruit. To do so, go to the Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your OAuth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (.com, .eu, .in, .com.cn, or .jp), which defaults to .com.

   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 specified in your app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
   • CallbackURL: Set this to the Redirect URI that is specified in your app settings.
   • Domain: Set this in ProfileSettings to your ZohoRecruit account domain (e.g. .com, .eu, .in, .com.cn, .jp).

   Example connection string:

   Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Zoho Recruit 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\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
   

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