Package com.force.api

Class ForceApi

java.lang.Object

com.force.api.ForceApi

public class ForceApi
extends Object

main class for making API calls. This class is cheap to instantiate and throw away. It holds a user's session as state and thus should never be reused across multiple user sessions, unless that's explicitly what you want to do. For web apps, you should instantiate this class on every request and feed it the session information as obtained from a session cookie or similar. An exception to this rule is if you make all API calls as a single API user. Then you can keep a static reference to this class.

Author:

jjoergensen

Constructor Summary

Constructors

Constructor	Description
ForceApi(ApiConfig apiConfig)
ForceApi(ApiConfig config, ApiSession session)
ForceApi(ApiSession session)

Method Summary

Modifier and Type	Method	Description
CreateOrUpdateResult	createOrUpdateSObject(String type, String externalIdField, String externalIdValue, Object sObject)
String	createSObject(String type, Object sObject)
String	curlHelper()
ResourceRepresentation	delete(String path)	sends a custom REST API DELETE request
void	deleteSObject(String type, String id)
DescribeGlobal	describeGlobal()
DescribeSObject	describeSObject(String sobject)
DescribeSObject	describeSObjectIfModified(String sobject, Date since)	Retrieves all the metadata for an object, including information about each field, URLs, and child relationships.
<T> DiscoverSObject<T>	discoverSObject(String sobject, Class<T> clazz)
ResourceRepresentation	get(String path)
Identity	getIdentity()
ApiSession	getSession()
ResourceRepresentation	getSObject(String type, String id)
SupportedVersions	getSupportedVersions()
ResourceRepresentation	patch(String path, Object input)	sends a custom REST API PATCH request
ResourceRepresentation	post(String path, Object input)	sends a custom REST API POST request
ResourceRepresentation	put(String path, Object input)	sends a custom REST API PUT request (no test for this method yet).
QueryResult<Map>	query(String query)
<T> QueryResult<T>	query(String query, Class<T> clazz)
<T> QueryResult<T>	queryAll(String query, Class<T> clazz)
QueryResult<Map>	queryMore(String nextRecordsUrl)
<T> QueryResult<T>	queryMore(String nextRecordsUrl, Class<T> clazz)
ResourceRepresentation	request(String method, String path, Object input)
void	updateSObject(String type, String id, Object sObject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ForceApi

public ForceApi(ApiConfig config, ApiSession session)

ForceApi

public ForceApi(ApiSession session)

ForceApi

public ForceApi(ApiConfig apiConfig)

Method Details

getSession

public ApiSession getSession()

curlHelper

public String curlHelper()

get

public ResourceRepresentation get(String path)

delete

public ResourceRepresentation delete(String path)

sends a custom REST API DELETE request

Parameters:

path - service path to be called - i.e. /process/approvals/

Returns:

response from API wrapped in a ResourceRepresentation for multiple deserialization options. DELETE responses are generally empty, so you may get an error if you try to deserialize into a class by calling `as(...)` on ResourceRepresentation. The DELETE can be assumed to have succeeded if this method does not throw an exception.

post

public ResourceRepresentation post(String path, Object input)

sends a custom REST API POST request

Parameters:

path - service path to be called - i.e. /process/approvals/

input - this object will be serialized as JSON and sent in tbe body of the request

Returns:

response from API wrapped in a ResourceRepresentation for multiple deserialization options

put

public ResourceRepresentation put(String path, Object input)

sends a custom REST API PUT request (no test for this method yet).

Parameters:

path - service path to be called - i.e. /process/approvals/

input - this object will be serialized as JSON and sent in tbe body of the request

Returns:

response from API wrapped in a ResourceRepresentation for multiple deserialization options

patch

public ResourceRepresentation patch(String path, Object input)

sends a custom REST API PATCH request

Parameters:

path - service path to be called - i.e. /process/approvals/

input - this object will be serialized as JSON and sent in tbe body of the request

Returns:

response from API wrapped in a ResourceRepresentation for multiple deserialization options

request

public ResourceRepresentation request(String method, String path, Object input)

getIdentity

public Identity getIdentity()

getSObject

public ResourceRepresentation getSObject(String type, String id) throws ResourceException

Throws:

ResourceException

createSObject

public String createSObject(String type, Object sObject)

updateSObject

public void updateSObject(String type, String id, Object sObject)

deleteSObject

public void deleteSObject(String type, String id)

createOrUpdateSObject

public CreateOrUpdateResult createOrUpdateSObject(String type, String externalIdField, String externalIdValue, Object sObject)

query

public <T> QueryResult<T> query(String query, Class<T> clazz)

query

public QueryResult<Map> query(String query)

queryMore

public <T> QueryResult<T> queryMore(String nextRecordsUrl, Class<T> clazz)

queryMore

public QueryResult<Map> queryMore(String nextRecordsUrl)

queryAll

public <T> QueryResult<T> queryAll(String query, Class<T> clazz)

describeGlobal

public DescribeGlobal describeGlobal()

getSupportedVersions

public SupportedVersions getSupportedVersions()

discoverSObject

public <T> DiscoverSObject<T> discoverSObject(String sobject, Class<T> clazz)

describeSObject

public DescribeSObject describeSObject(String sobject)

describeSObjectIfModified

public DescribeSObject describeSObjectIfModified(String sobject, Date since)

Retrieves all the metadata for an object, including information about each field, URLs, and child relationships. Response metadata will only be returned if the object metadata has changed since the provided date.

Parameters:

sobject - object name

since - date that is used to identify if metadata has been changed since

Returns:

the metadata for an object, null if no changes since provided date