Force.com REST API Connector

Lightweight library for building Force.com apps with OAuth authentication and data access through the Force.com REST API.

Usage

You can either include as a dependency and pull the module from its github maven repo or you can build locally.

Dependency on published release

The version number is bumped regularly. Check the tags list or commit messages for latest version.

Maven

<repositories>
    <repository>
        <id>force-rest-api</id>
        <name>force-rest-api repository on GitHub</name>
        <url>http://jesperfj.github.com/force-rest-api/repository/</url>            
    </repository>
</repositories>

...

<dependency>
    <groupId>com.force.api</groupId>
    <artifactId>force-rest-api</artifactId>
    <version>0.0.15</version>
</dependency>

Build and link locally

$ git clone https://github.com/jesperfj/force-rest-api.git
$ cd force-rest-api
$ mvn install -DskipTests

Maven

The latest HEAD always builds to a snapshot:

<dependency>
    <groupId>com.force.api</groupId>
    <artifactId>force-rest-api</artifactId>
    <version>0.0.16-SNAPSHOT</version>
</dependency>

Authentication and Instantiation

Username / Password Authentication

Authenticate using just login and password:

ForceApi api = new ForceApi(new ApiConfig()
    .setUsername("user@domain.com")
    .setPassword("password"));

OAuth Username/Password Authentication Flow

As documented here

ForceApi api = new ForceApi(new ApiConfig()
    .setUsername("user@domain.com")
    .setPassword("password")
    .setClientId("longclientidalphanumstring")
    .setClientSecret("notsolongnumeric"));

OAuth Web Server Flow

As documented here

String url = Auth.startOAuthWebServerFlow(new AuthorizationRequest()
	.apiConfig(new ApiConfig()
		.setClientId("longclientidalphanumstring")
		.setRedirectURI("https://myapp.mydomain.com/oauth"))
	.state("mystate"));

// redirect browser to url
// Browser will get redirected back to your app after user authentication at
// https://myapp.mydomain.com/oauth with a code parameter. Now do:

ApiSession s = Auth.completeOAuthWebServerFlow(new AuthorizationResponse()
	.apiConfig(new ApiConfig()
		.setClientId("longclientidalphanumstring")
		.setClientSecret("notsolongnumeric")
		.setRedirectURI("https://myapp.mydomain.com/oauth"))
	.code("alphanumericstringpassedbackinbrowserrequest"));

ForceApi api = new ForceApi(s.getApiConfig(),s);

Instantiate with existing accessToken and endpoint

If you already have an access token and endpoint (e.g. from a cookie), you can pass an ApiSession instance to ForceApi:

ApiConfig c = new ApiConfig()
    .setRefreshToken("refreshtoken")
    .setClientId("longclientidalphanumstring")
    .setClientSecret("notsolongnumeric"),

ApiSession s = new ApiSession()
    .setApiConfig(c)
    .setAccessToken("accessToken")
    .setApiEndpoint("apiEndpoint");

ForceApi api = new ForceApi(c,s);

CRUD and Query Operations

Get an SObject

Account res = api.getSObject("Account", "001D000000INjVe").as(Account.class);

This assumes you have an Account class defined with proper Jackson deserialization annotations. For example:

import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonProperty;

@JsonIgnoreProperties(ignoreUnknown=true)
public class Account {

	@JsonProperty(value="Id")
	String id;
	@JsonProperty(value="Name")
	String name;
	@JsonProperty(value="AnnualRevenue")
	private Double annualRevenue;
	@JsonProperty(value="externalId__c")
	String externalId;	

	public String getId() { return id; }
	public void setId(String id) { this.id = id; }
	public String getName() { return name; }
	public void setName(String name) { this.name = name; }
	public Double getAnnualRevenue() { return annualRevenue; }
	public void setAnnualRevenue(Double value) { annualRevenue = value; }
	public String getExternalId() { return externalId; }
	public void setExternalId(String externalId) { this.externalId = externalId; }
}

Create SObject

Account a = new Account();
a.setName("Test account");
String id = api.createSObject("account", a);

Update SObject

a.setName("Updated Test Account");
api.updateSObject("account", id, a);

Create or Update SObject

a = new Account();
a.setName("Perhaps existing account");
a.setAnnualRevenue(3141592.65);
api.createOrUpdateSObject("account", "externalId__c", "1234", a);

Delete an SObject

api.deleteSObject("account", id);

Query SObjects

QueryResult<Account> res = api.query("SELECT id FROM Account WHERE name LIKE 'Test account%'", Account.class);

Run Tests

This project currently only has integration-y tests (they hit the actual API). To make them work copy src/test/resources/test.properties.sample to src/test/resources/test.properties and replace the properties in the file with actual values

Login and password

Add your Force.com developer org login and password. Needless to say, don't use credentials for a production org containing sensitive data. If you don't have a developer org, sign up for one. It's free.

Client ID and Secret

Once you have signed up for an org, navigate to the Remote Access Setup:

• Click on "Admin User" drop-down in upper-right
• Select Setup
• In the left-side navigation pane, under "App Setup", click on "Develop"
• Select "Remote Access"

Now create a new Remote Access Application:

• Click on "New"
• Choose any name for your application
• Choose any callback URL (you'll need to set this properly when web server flow is supported)
• Choose some contact email
• Click "Save"
• Copy "Consumer Key" to the property "clientId" in test.properties
• Click on "Click to reveal" and copy "Consumer Secret" to "clientSecret" in test.properties

Add externalId__c to Account SObject

Use the Force.com Web UI to add a custom field called externalId__c and mark it as an external ID field:

• (sorry, you have to figure out how to do this yourself. Will add instructions or automate it later)

Now run tests with

$ mvn test

Cutting a Release

This project uses the Maven release plugin with Github pages as Maven repo to facilitate quick releases. Snapshots are never released. They are reserved for local builds. See Christian Kaltepoth's post for an excellent guide to setting up Github pages as a maven repo. To cut a release: (adjust repo references as necessary below if you're on a fork or doing this on your own repo)

Clone this repo

$ git clone git@github.com:jesperfj/force-rest-api.git

Clone the github pages branch of this repo into release-repo sub-dir

$ cd force-rest-api
$ git clone -b gh-pages git@github.com:jesperfj/force-rest-api.git release-repo

Prepare a new release

Set up your test properties as described above in the testing section. Tests must pass. Edit pom.xml and adjust the SCM information to match your repo and github info if different from this one. Run

$ mvn release:prepare

This will create a couple of commits and push to your github repo. A new release has now been created and snapshotted in github, but it has not yet actually been built and deployed.

Build and deploy the new release

You can't use mvn release:perform because it will be missing your test fixture. Instead just do it manually. Check out the commit that was tagged as the new release. Something like:

$ git checkout force-rest-api-0.0.4

Build and deploy

$ mvn clean deploy -DupdateReleaseInfo

Commit the new release and push to gh-pages

$ cd release-repo
$ git add .
$ git commit -m "Release 0.0.4"
$ git push origin gh-pages

Clean up

$ cd ..
$ mvn release:clean

(deletes temporary and backup files)

$ git checkout master

gets you back to master from detached HEAD.

Release History

0.0.19

• ryanbrainard added QueryMore and various other enhancements to make it work better with RichSObjects
• Burn0ut07 added PickListEntry support to DescribeSObject

0.0.18

• Some relationship queries work now. See QueryTest for an example.
• Tested with Jackson 1.9.7

0.0.17

• Modified deserialization of query results to better supper queries that return graphs of records.

0.0.16

• Added more testing, including an end-to-end oauth flow test using HtmlUnit
• Scope is now an enum

0.0.15

• ApiSession now serializable, so it can be cached in Memcached and similar

0.0.14

• Fixed bug in DescribeSObject. Had inlineHelpText as boolean instead of String

0.0.13

• More complete DescribeSObject. Can now be used to generate Java classes. An example can be found in the tests based on PojoCodeGenerator

0.0.12

• 0.0.11 broke describeSObject. Fixed now and added test

0.0.11

0.0.10 was botched. Missed a checkin

0.0.10

• Basic exceptions
• Some internal refactorings
• First attempt at session renewal

0.0.9

• Minimalistic Describe

0.0.8

• Added revoke support (read more)
• Refactored refreshToken out of ApiConfig

0.0.7

• Added support for OAuth refresh_token flow
• Added a bit more debug info to createSObject
• Should work with Jackson 1.9.1 and 1.9.2. Both are accepted in the version range

0.0.6

• Tested with Winter '12, API version 23
• Requires (and explicitly declares dependency on) Jackson 1.9.1. Not tested with other Jackson versions.
• Basic CRUD and query functionality for SObjects
• OAuth functionality that covers all Force.com options
• Only happy path tested, almost no error scenarios or edge cases covered except for some sporadic debug output
• Focused on typed access. But you must build SObject classes manually for now (or use builders available elsewhere)

Project Goals:

• Make it as thin as possible
  • Status: Both ForceApi and Auth classes are very thin wrappers on top of the APIs.
• Few or no dependencies
  • Status: Currently only depends on Jackson. Could consider supporting gson as well for added flexibility
• Other projects will handle generation of typed SObject classes and it should work here
• Automatic session renewal
  • Status: Added in 0.0.10 and testable in 0.0.12. Waiting for feedback to see if it works.
• Pluggable JSON kit
  • Status: Not yet. This is currently low priority
• Make sure it's Spring friendly. This solution may be necessary.
  • Status: No Spring work has been done yet
• Consider adding newrelic hooks.

License

BSD 3-clause license

Author

Jesper Joergensen