Connect to Halo Service Desk Data from a Connection Pool in Jetty

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

   
   
   <Configure id='haloservicedeskdemo' class="org.eclipse.jetty.webapp.WebAppContext">
       <New id="haloservicedeskdemo" class="org.eclipse.jetty.plus.jndi.Resource">
       <Arg><Ref refid="haloservicedeskdemo"/></Arg>
       <Arg>jdbc/haloservicedeskdb</Arg>
       <Arg>
         <New class="cdata.jdbc.api.APIDriver">
           <Set name="url">jdbc:api:</Set>
           <Set name="Profile">C:\profiles\HaloServiceDesk.apip</Set>
           <Set name="AuthScheme">APIKey</Set>
           <Set name="ProfileSettings">'APIKey</Set>
           <Set name="Domain">yourcompany.haloservicedesk.com'</Set>
         </New>
       </Arg>
     </New>
   </Configure>
   

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

   HaloServiceDesk API Profile Settings

   HaloServiceDesk uses API key authentication. You can find or create API keys in HaloServiceDesk under Administration > Integrations > Halo API.

   Set the following connection properties to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to the API key from your HaloServiceDesk account.
   • Domain: Set this to the hostname of your HaloServiceDesk instance (e.g. yourcompany.haloservicedesk.com).

4. Configure the resource in the Web.xml:

   
   
     jdbc/haloservicedeskdb
     javax.sql.DataSource
     Container
   
   

5. You can then access Halo Service Desk with a lookup to java:comp/env/jdbc/haloservicedeskdb:

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

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.