Connect to ShipEngine Data from a Connection Pool in Jetty

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

   
   <Configure id='shipenginedemo' class="org.eclipse.jetty.webapp.WebAppContext">
       <New id="shipenginedemo" class="org.eclipse.jetty.plus.jndi.Resource">
       <Arg><Ref refid="shipenginedemo"/></Arg>
       <Arg>jdbc/shipenginedb</Arg>
       <Arg>
         <New class="cdata.jdbc.api.APIDriver">
           <Set name="url">jdbc:api:</Set>
           <Set name="Profile">C:\profiles\ShipEngine.apip</Set>
           <Set name="ProfileSettings">'APIKey</Set>
         </New>
       </Arg>
     </New>
   </Configure>
   

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

   ShipEngine API Profile Settings

   Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

4. Configure the resource in the Web.xml:

   
     jdbc/shipenginedb
     javax.sql.DataSource
     Container
   
   

5. You can then access ShipEngine with a lookup to java:comp/env/jdbc/shipenginedb:

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

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.