SalesforceConnector

Class Overview

The Salesforce Connector will allow to connect to the Salesforce application using regular username and password via the SOAP API. Almost every operation that can be done via the Salesforce's API can be done thru this connector. This connector will also work if your Salesforce objects are customized with additional fields or even you are working with custom objects.

Integrating with Salesforce consists of web service calls utilizing XML request/response setup over an HTTPS connection. The technical details of this connection such as request headers, error handling, HTTPS connection, etc. are all abstracted from the user to make implementation quick and easy.

{@sample.config INCLUDE_ERROR}

Summary

[Expand] Inherited Fields

From class org.mule.modules.salesforce.BaseSalesforceConnector private static final Logger LOGGER private Boolean allowFieldTruncationSupport If true, truncate field values that are too long, which is the behavior in API versions 14.0 and earlier. private String assignmentRuleId The ID of a specific assignment rule to run for the Case or Lead. private SalesforceBayeuxClient bc Bayeux client private String clientId Client ID for partners private ObjectStoreHelper objectStoreHelper private ObjectStoreManager objectStoreManager Object store manager to obtain a store to support this#getUpdatedObjects private Registry registry private ObjectStore timeObjectStore A ObjectStore instance to use in this#getUpdatedObjects private Boolean useDefaultRule If true for a Case or Lead, uses the default (active) assignment rule for a Case or Lead.

[Expand] Inherited Methods
From class org.mule.modules.salesforce.BaseSalesforceConnector JobInfo abortJob(String jobId) Aborts an open Job given its ID. BatchInfo batchInfo(BatchInfo batchInfo) Access latest BatchInfo of a submitted BatchInfo. BatchResult batchResult(BatchInfo batchInfo) Access BatchResult of a submitted BatchInfo. InputStream batchResultStream(BatchInfo batchInfo) Access BatchResult of a submitted BatchInfo. JobInfo closeJob(String jobId) Closes an open Job given its ID. LeadConvertResult convertLead(String leadId, String contactId, String accountId, Boolean overWriteLeadSource, Boolean doNotCreateOpportunity, String opportunityName, String convertedStatus, Boolean sendEmailToOwner) Converts a Lead into an Account, Contact, or (optionally) an Opportunity. List<SaveResult> create(String type, List<Map<String, Object>> objects) Adds one or more new records to your organization's data. BatchInfo createBatch(JobInfo jobInfo, List<Map<String, Object>> objects) Creates a Batch using the given objects within the specified Job. BatchInfo createBatchForQuery(JobInfo jobInfo, String query) Creates a Batch using the given query. BatchInfo createBatchStream(JobInfo jobInfo, InputStream stream) Creates a Batch using the given stream within the specified Job. BatchInfo createBulk(String type, List<Map<String, Object>> objects) Adds one or more new records to your organization's data. JobInfo createJob(OperationEnum operation, String type, String externalIdFieldName, ContentType contentType, ConcurrencyMode concurrencyMode) Creates a Job in order to perform one or more batches through Bulk API Operations. SaveResult createSingle(String type, Map<String, Object> object) Adds one new records to your organization's data. List<DeleteResult> delete(List<String> ids) Deletes one or more records from your organization's data. DescribeGlobalResult describeGlobal() Retrieves a list of available objects for your organization's data. DescribeSObjectResult describeSObject(String type) Describes metadata (field list and object properties) for the specified object. List<EmptyRecycleBinResult> emptyRecycleBin(List<String> ids) The recycle bin lets you view and restore recently deleted records for 30 days before they are permanently deleted. Boolean getAllowFieldTruncationSupport() String getAssignmentRuleId() SalesforceBayeuxClient getBayeuxClient() abstract BulkConnection getBulkConnection() String getClientId() abstract PartnerConnection getConnection() GetDeletedResult getDeleted(String type, int duration) Retrieves the list of individual records that have been deleted between the range of now to the duration before now. GetDeletedResult getDeletedRange(String type, Calendar startTime, Calendar endTime) Retrieves the list of individual records that have been deleted within the given timespan for the specified object. abstract String getSessionId() ObjectStore getTimeObjectStore() GetUpdatedResult getUpdated(String type, int duration) Retrieves the list of individual records that have been updated between the range of now to the duration before now. List<Map<String, Object>> getUpdatedObjects(String type, int initialTimeWindow, List<String> fields) Retrieves the list of records that have been updated between the last time this method was called and now. GetUpdatedResult getUpdatedRange(String type, Calendar startTime, Calendar endTime) Retrieves the list of individual records that have been created/updated within the given timespan for the specified object. Boolean getUseDefaultRule() GetUserInfoResult getUserInfo() Retrieves personal information for the user associated with the current session. BatchInfo hardDeleteBulk(String type, List<Map<String, Object>> objects) Deletes one or more records from your organization's data. boolean isInitializedBayeuxClient() QueryResultObject paginatedQuery(String query, QueryResultObject queryResultObject, Boolean withDeletedRecords) Executes a paginated query against the specified object and returns data that matches the specified criteria. void publishTopic(String topicName, String query, String description) Creates a topic which represents a query that is the basis for notifying listeners of changes to records in an organization. List<Map<String, Object>> query(String query) Executes a query against the specified object and returns data that matches the specified criteria. List<Map<String, Object>> queryAll(String query) Retrieves data from specified objects, whether or not they have been deleted. InputStream queryResultStream(BatchInfo batchInfo) Returns an InputStream with the query results of a submitted BatchInfo Map<String, Object> querySingle(String query) Executes a query against the specified object and returns the first record that matches the specified criteria. void resetUpdatedObjectsTimestamp(String type) Resets the timestamp of the last updated object. List<Map<String, Object>> retrieve(String type, List<String> ids, List<String> fields) Retrieves one or more records based on the specified IDs. List<Map<String, Object>> search(String query) Search for objects using Salesforce Object Search Language void setAllowFieldTruncationSupport(Boolean allowFieldTruncationSupport) void setAssignmentRuleId(String assignmentRuleId) void setBayeuxClient(SalesforceBayeuxClient bc) void setClientId(String clientId) void setConnectionOptions(PartnerConnection connection) void setMuleContext(MuleContext context) void setObjectStoreHelper(ObjectStoreHelper objectStoreHelper) void setObjectStoreManager(ObjectStoreManager objectStoreManager) void setPassword(String userId, String newPassword) Change the password of a User or SelfServiceUser to a value that you specify. void setRegistry(Registry registry) void setTimeObjectStore(ObjectStore timeObjectStore) void setUseDefaultRule(Boolean useDefaultRule) StopSourceCallback subscribeTopic(String topic, SourceCallback callback) Subscribe to a topic. SObject[] toAsyncSObjectList(List<Map<String, Object>> objects) SObject[] toSObjectList(String type, List<Map<String, Object>> objects) List<SaveResult> update(String type, List<Map<String, Object>> objects) Updates one or more existing records in your organization's data. BatchInfo updateBulk(String type, List<Map<String, Object>> objects) Updates one or more existing records in your organization's data. SaveResult updateSingle(String type, Map<String, Object> object) Updates one or more existing records in your organization's data. List<UpsertResult> upsert(String externalIdFieldName, String type, List<Map<String, Object>> objects) Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. BatchInfo upsertBulk(String type, String externalIdFieldName, List<Map<String, Object>> objects) Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.mule.api.context.MuleContextAware abstract void setMuleContext(MuleContext arg0)