Create a Data Access Object for Salesforce Chatter Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Chatter JDBC Driver

A straightforward interface to connect any Java application with Salesforce Chatter integration capabilities including Comments, Groups, Feeds, and more!

A brief overview of creating a SQL Object API for Salesforce Chatter data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Salesforce Chatter integrates connectivity to live Salesforce Chatter data in Java applications. By pairing these technologies, you gain simple, programmatic access to Salesforce Chatter data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Salesforce Chatter data.

Create a DAO for the Salesforce Chatter Users Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyUsersDAO { //request specific data from Salesforce Chatter (String type is used for simplicity) @SqlQuery("SELECT PostCount FROM Users WHERE SearchTerms = :searchTerms") String findPostCountBySearchTerms(@Bind("searchTerms") String searchTerms); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Salesforce Chatter

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Salesforce Chatter.

Salesforce Chatter uses OAuth 2.0 authentication. To authenticate to Salesforce Chatter via OAuth 2.0, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Salesforce Chatter.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Salesforce Chatter JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.salesforcechatter.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Salesforce Chatter will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:salesforcechatter:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:343343;InitiateOAuth=GETANDREFRESH"); MyUsersDAO dao =; //do stuff with the DAO dao.close();

Read Salesforce Chatter Data

With the connection open to Salesforce Chatter, simply call the previously defined method to retrieve data from the Users entity in Salesforce Chatter.

//disply the result of our 'find' method String postCount = dao.findPostCountBySearchTerms("Smoked*BBQ"); System.out.println(postCount);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Salesforce Chatter by integrating with the CData JDBC Driver for Salesforce Chatter. Download a free trial and work with live Salesforce Chatter data in custom Java applications today.