Connect to Sugar CRM Data from a Connection Pool in Jetty

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Sugar JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sugar account data including Leads, Contacts, Opportunities, Accounts, and more!



The Sugar CRM JDBC Driver supports connection pooling: This article shows how to connect faster to Sugar CRM data from Web apps in Jetty.

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

    <Configure id='sugarcrmdemo' class="org.eclipse.jetty.webapp.WebAppContext"> <New id="sugarcrmdemo" class="org.eclipse.jetty.plus.jndi.Resource"> <Arg><Ref refid="sugarcrmdemo"/></Arg> <Arg>jdbc/sugarcrmdb</Arg> <Arg> <New class="cdata.jdbc.sugarcrm.SugarCRMDriver"> <Set name="url">jdbc:sugarcrm:</Set> <Set name="User">MyUser</Set> <Set name="Password">MyPassword</Set> <Set name="URL">MySugarCRMAccountURL</Set> <Set name="CacheMetadata">True</Set> </New> </Arg> </New> </Configure>

    The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

    You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

    Additionally, specify the URL to the SugarCRM account.

    Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

  4. Configure the resource in the Web.xml:

    jdbc/sugarcrmdb javax.sql.DataSource Container
  5. You can then access Sugar CRM with a lookup to java:comp/env/jdbc/sugarcrmdb: InitialContext ctx = new InitialContext(); DataSource mysugarcrm = (DataSource)ctx.lookup("java:comp/env/jdbc/sugarcrmdb");

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.