Connect to IBM Cloud Object Storage Data from a Connection Pool in Jetty

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

   <Configure id='ibmcloudobjectstoragedemo' class="org.eclipse.jetty.webapp.WebAppContext">
    <New id="ibmcloudobjectstoragedemo" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg><Ref refid="ibmcloudobjectstoragedemo"/></Arg>
    <Arg>jdbc/ibmcloudobjectstoragedb</Arg>
    <Arg>
    <New class="cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver">
    <Set name="url">jdbc:ibmcloudobjectstorage:</Set>
    <Set name="ApiKey">myApiKey</Set>
    <Set name="CloudObjectStorageCRN">MyInstanceCRN</Set>
    <Set name="Region">myRegion</Set>
    <Set name="OAuthClientId">MyOAuthClientId</Set>
    <Set name="OAuthClientSecret">myOAuthClientSecret</Set>
    </New>
    </Arg>
    </New>
   </Configure>
   

   Register a New Instance of Cloud Object Storage

   If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

   1. Log in to your IBM Cloud account.
   2. Navigate to the

   Connecting using OAuth Authentication

   There are certain connection properties you need to set before you can connect. You can obtain these as follows:

   API Key

   To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

   1. Log in to your IBM Cloud account.
   2. Navigate to the Platform API Keys page.
   3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
   4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

   Cloud Object Storage CRN

   If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

   • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
   • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

   Connecting to Data

   You can now set the following to connect to data:

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • ApiKey: Set this to your API key which was noted during setup.
   • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

   When you connect, the connector completes the OAuth process.

   1. Extracts the access token and authenticates requests.
   2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

4. Configure the resource in the Web.xml:

    jdbc/ibmcloudobjectstoragedb
    javax.sql.DataSource
    Container
   
   

5. You can then access IBM Cloud Object Storage with a lookup to java:comp/env/jdbc/ibmcloudobjectstoragedb:

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

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.