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 and Description
ForceApi(ApiConfig apiConfig)
ForceApi(ApiConfig config, ApiSession session)
ForceApi(ApiSession session)

Method Summary

Modifier and Type	Method and Description
CreateOrUpdateResult	createOrUpdateSObject(String type, String externalIdField, String externalIdValue, Object sObject)
String	createSObject(String type, Object sObject)
void	deleteSObject(String type, String id)
DescribeGlobal	describeGlobal()
DescribeSObject	describeSObject(String sobject)
<T> DiscoverSObject<T>	discoverSObject(String sobject, Class<T> clazz)
Identity	getIdentity()
ResourceRepresentation	getSObject(String type, String id)
QueryResult<Map>	query(String query)
<T> QueryResult<T>	query(String query, Class<T> clazz)
QueryResult<Map>	queryMore(String nextRecordsUrl)
<T> QueryResult<T>	queryMore(String nextRecordsUrl, Class<T> clazz)
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 Detail

ForceApi

public ForceApi(ApiConfig config,
                ApiSession session)

ForceApi

public ForceApi(ApiSession session)

ForceApi

public ForceApi(ApiConfig apiConfig)

Method Detail

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)

describeGlobal

public DescribeGlobal describeGlobal()

discoverSObject

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

describeSObject

public DescribeSObject describeSObject(String sobject)