Create a Data Access Object for Salesforce Data using 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 integrates connectivity to live Salesforce data in Java applications. By pairing these technologies, you gain simple, programmatic access to Salesforce data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read and write Salesforce data.

Getting Started

---

Create a DAO for the Salesforce Account 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 MyAccountDAO {
 //insert new data into Salesforce
 @SqlUpdate("INSERT INTO Account (Name, AnnualRevenue) values (:name, :annualRevenue)")
 void insert(@Bind("name") String name, @Bind("annualRevenue") String annualRevenue);

 //request specific data from Salesforce (String type is used for simplicity)
 @SqlQuery("SELECT AnnualRevenue FROM Account WHERE Name = :name")
 String findAnnualRevenueByName(@Bind("name") String name);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to Salesforce

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

There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

Multi-Factor Authentication (MFA)

If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

Built-in Connection String Designer

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

java -jar cdata.jdbc.salesforce.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode

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:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read Salesforce Data

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

//disply the result of our 'find' method
String annualRevenue = dao.findAnnualRevenueByName("GenePoint");
System.out.println(annualRevenue);

Write Salesforce Data

It is also simple to write data to Salesforce, using the previously defined method.

//add a new entry to the Account entity
dao.insert(newName, newAnnualRevenue);

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