Constructor and Description |
---|
SalesforceEndpointConfig() |
Modifier and Type | Method and Description |
---|---|
SalesforceEndpointConfig |
copy() |
String |
getApexMethod() |
Map<String,Object> |
getApexQueryParams() |
String |
getApexUrl() |
String |
getApiVersion() |
ApprovalRequest |
getApproval() |
ApprovalRequest.Action |
getApprovalActionType() |
String |
getApprovalComments() |
String |
getApprovalContextActorId() |
String |
getApprovalContextId() |
List<String> |
getApprovalNextApproverIds() |
String |
getApprovalProcessDefinitionNameOrId() |
long |
getBackoffIncrement() |
String |
getBatchId() |
ContentType |
getContentType() |
Long |
getDefaultReplayId() |
PayloadFormat |
getFormat() |
SalesforceHttpClient |
getHttpClient() |
Boolean |
getIncludeDetails() |
Map<String,Long> |
getInitialReplayIdMap() |
String |
getInstanceId() |
String |
getJobId() |
Integer |
getLimit() |
long |
getMaxBackoff() |
NotFoundBehaviour |
getNotFoundBehaviour() |
NotifyForFieldsEnum |
getNotifyForFields() |
Boolean |
getNotifyForOperationCreate() |
Boolean |
getNotifyForOperationDelete() |
NotifyForOperationsEnum |
getNotifyForOperations() |
Boolean |
getNotifyForOperationUndelete() |
Boolean |
getNotifyForOperationUpdate() |
com.fasterxml.jackson.databind.ObjectMapper |
getObjectMapper() |
boolean |
getRawPayload() |
String |
getReportId() |
ReportMetadata |
getReportMetadata() |
String |
getResultId() |
String |
getSObjectBlobFieldName() |
String |
getSObjectClass() |
String |
getSObjectFields() |
String |
getSObjectId() |
String |
getSObjectIdName() |
String |
getSObjectIdValue() |
String |
getSObjectName() |
String |
getSObjectQuery() |
String |
getSObjectSearch() |
boolean |
isApprovalSkipEntryCriteria() |
boolean |
isSerializeNulls() |
boolean |
isUpdateTopic() |
void |
setApexMethod(String apexMethod)
APEX method name
|
void |
setApexQueryParams(Map<String,Object> apexQueryParams)
Query params for APEX method
|
void |
setApexUrl(String apexUrl)
APEX method URL
|
void |
setApiVersion(String apiVersion)
Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION
|
void |
setApproval(ApprovalRequest approval)
The approval request for Approval API.
|
void |
setApprovalActionType(ApprovalRequest.Action actionType)
Represents the kind of action to take: Submit, Approve, or Reject.
|
void |
setApprovalComments(String comments)
The comment to add to the history step associated with this request.
|
void |
setApprovalContextActorId(String contextActorId)
The ID of the submitter who’s requesting the approval record.
|
void |
setApprovalContextId(String contextId)
The ID of the item that is being acted upon.
|
void |
setApprovalNextApproverIds(List<String> nextApproverIds)
If the process requires specification of the next approval, the ID of the user to be assigned the next request.
|
void |
setApprovalNextApproverIds(String nextApproverId)
If the process requires specification of the next approval, the ID of the user to be assigned the next request.
|
void |
setApprovalProcessDefinitionNameOrId(String processDefinitionNameOrId)
The developer name or ID of the process definition.
|
void |
setApprovalSkipEntryCriteria(boolean skipEntryCriteria)
Determines whether to evaluate the entry criteria for the process (true) or not (false) if the process definition
name or ID isn’t null.
|
void |
setBackoffIncrement(long backoffIncrement)
Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
|
void |
setBatchId(String batchId)
Bulk API Batch ID
|
void |
setContentType(ContentType contentType)
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV
|
void |
setDefaultReplayId(Long defaultReplayId)
Default replayId setting if no value is found in
initialReplayIdMap |
void |
setFormat(PayloadFormat format)
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON
|
void |
setHttpClient(SalesforceHttpClient httpClient)
Custom Jetty Http Client to use to connect to Salesforce.
|
void |
setIncludeDetails(Boolean includeDetails)
Include details in Salesforce1 Analytics report, defaults to false.
|
void |
setInitialReplayIdMap(Map<String,Long> initialReplayIdMap)
Replay IDs to start from per channel name.
|
void |
setInstanceId(String instanceId)
Salesforce1 Analytics report execution instance ID
|
void |
setJobId(String jobId)
Bulk API Job ID
|
void |
setLimit(Integer limit)
Limit on number of returned records.
|
void |
setMaxBackoff(long maxBackoff)
Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
|
void |
setNotFoundBehaviour(NotFoundBehaviour notFoundBehaviour)
Sets the behaviour of 404 not found status received from Salesforce API.
|
void |
setNotifyForFields(NotifyForFieldsEnum notifyForFields)
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE
|
void |
setNotifyForOperationCreate(Boolean notifyForOperationCreate)
Notify for create operation, defaults to false (API version >= 29.0)
|
void |
setNotifyForOperationDelete(Boolean notifyForOperationDelete)
Notify for delete operation, defaults to false (API version >= 29.0)
|
void |
setNotifyForOperations(NotifyForOperationsEnum notifyForOperations)
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)
|
void |
setNotifyForOperationUndelete(Boolean notifyForOperationUndelete)
Notify for un-delete operation, defaults to false (API version >= 29.0)
|
void |
setNotifyForOperationUpdate(Boolean notifyForOperationUpdate)
Notify for update operation, defaults to false (API version >= 29.0)
|
void |
setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
|
void |
setRawPayload(boolean rawPayload)
Use raw payload
String for request and response (either JSON or XML depending on format ),
instead of DTOs, false by default |
void |
setReportId(String reportId)
Salesforce1 Analytics report Id
|
void |
setReportMetadata(ReportMetadata reportMetadata)
Salesforce1 Analytics report metadata for filtering
|
void |
setResultId(String resultId)
Bulk API Result ID
|
void |
setSerializeNulls(boolean serializeNulls)
Should the NULL values of given DTO be serialized with
empty (NULL) values.
|
void |
setSObjectBlobFieldName(String sObjectBlobFieldName)
SObject blob field name
|
void |
setSObjectClass(String sObjectClass)
Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin
|
void |
setSObjectFields(String sObjectFields)
SObject fields to retrieve
|
void |
setSObjectId(String sObjectId)
SObject ID if required by API
|
void |
setSObjectIdName(String sObjectIdName)
SObject external ID field name
|
void |
setSObjectIdValue(String sObjectIdValue)
SObject external ID field value
|
void |
setSObjectName(String sObjectName)
SObject name if required or supported by API
|
void |
setSObjectQuery(String sObjectQuery)
Salesforce SOQL query string
|
void |
setSObjectSearch(String sObjectSearch)
Salesforce SOSL search string
|
void |
setUpdateTopic(boolean updateTopic)
Whether to update an existing Push Topic when using the Streaming API, defaults to false
|
Map<String,Object> |
toValueMap() |
public static final String DEFAULT_VERSION
public static final String API_VERSION
public static final String FORMAT
public static final String RAW_PAYLOAD
public static final String SOBJECT_NAME
public static final String SOBJECT_ID
public static final String SOBJECT_FIELDS
public static final String SOBJECT_EXT_ID_NAME
public static final String SOBJECT_EXT_ID_VALUE
public static final String SOBJECT_BLOB_FIELD_NAME
public static final String SOBJECT_CLASS
public static final String SOBJECT_QUERY
public static final String SOBJECT_SEARCH
public static final String APEX_METHOD
public static final String APEX_URL
public static final String LIMIT
public static final String APEX_QUERY_PARAM_PREFIX
public static final String CONTENT_TYPE
public static final String JOB_ID
public static final String BATCH_ID
public static final String RESULT_ID
public static final String REPORT_ID
public static final String INCLUDE_DETAILS
public static final String REPORT_METADATA
public static final String INSTANCE_ID
public static final String DEFAULT_REPLAY_ID
public static final String INITIAL_REPLAY_ID_MAP
public static final String APPROVAL
public static final int DEFAULT_MAX_AUTHENTICATION_RETRIES
public static final long DEFAULT_BACKOFF_INCREMENT
public static final long DEFAULT_MAX_BACKOFF
public static final String NOT_FOUND_BEHAVIOUR
public static final String SERIALIZE_NULLS
public SalesforceEndpointConfig copy()
public PayloadFormat getFormat()
public void setFormat(PayloadFormat format)
public boolean getRawPayload()
public void setRawPayload(boolean rawPayload)
String
for request and response (either JSON or XML depending on format
),
instead of DTOs, false by defaultpublic String getApiVersion()
public void setApiVersion(String apiVersion)
public String getSObjectName()
public void setSObjectName(String sObjectName)
public String getSObjectId()
public void setSObjectId(String sObjectId)
public String getSObjectFields()
public void setSObjectFields(String sObjectFields)
public String getSObjectIdName()
public void setSObjectIdName(String sObjectIdName)
public String getSObjectIdValue()
public void setSObjectIdValue(String sObjectIdValue)
public String getSObjectBlobFieldName()
public void setSObjectBlobFieldName(String sObjectBlobFieldName)
public String getSObjectClass()
public void setSObjectClass(String sObjectClass)
public String getSObjectQuery()
public void setSObjectQuery(String sObjectQuery)
public String getSObjectSearch()
public void setSObjectSearch(String sObjectSearch)
public void setSerializeNulls(boolean serializeNulls)
public boolean isSerializeNulls()
public String getApexMethod()
public void setApexMethod(String apexMethod)
public String getApexUrl()
public void setApexUrl(String apexUrl)
public void setApexQueryParams(Map<String,Object> apexQueryParams)
public ApprovalRequest getApproval()
public void setApproval(ApprovalRequest approval)
approval
- public ContentType getContentType()
public void setContentType(ContentType contentType)
public String getJobId()
public void setJobId(String jobId)
public String getBatchId()
public void setBatchId(String batchId)
public String getResultId()
public void setResultId(String resultId)
public boolean isUpdateTopic()
public void setUpdateTopic(boolean updateTopic)
public NotifyForFieldsEnum getNotifyForFields()
public void setNotifyForFields(NotifyForFieldsEnum notifyForFields)
public NotifyForOperationsEnum getNotifyForOperations()
public void setNotifyForOperations(NotifyForOperationsEnum notifyForOperations)
public Boolean getNotifyForOperationCreate()
public void setNotifyForOperationCreate(Boolean notifyForOperationCreate)
public Boolean getNotifyForOperationUpdate()
public void setNotifyForOperationUpdate(Boolean notifyForOperationUpdate)
public Boolean getNotifyForOperationDelete()
public void setNotifyForOperationDelete(Boolean notifyForOperationDelete)
public Boolean getNotifyForOperationUndelete()
public void setNotifyForOperationUndelete(Boolean notifyForOperationUndelete)
public String getReportId()
public void setReportId(String reportId)
public Boolean getIncludeDetails()
public void setIncludeDetails(Boolean includeDetails)
public ReportMetadata getReportMetadata()
public void setReportMetadata(ReportMetadata reportMetadata)
public String getInstanceId()
public void setInstanceId(String instanceId)
public void setHttpClient(SalesforceHttpClient httpClient)
public SalesforceHttpClient getHttpClient()
public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
public long getBackoffIncrement()
public void setBackoffIncrement(long backoffIncrement)
public long getMaxBackoff()
public void setMaxBackoff(long maxBackoff)
public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
public Long getDefaultReplayId()
public void setDefaultReplayId(Long defaultReplayId)
initialReplayIdMap
defaultReplayId
- public void setInitialReplayIdMap(Map<String,Long> initialReplayIdMap)
public Integer getLimit()
public void setLimit(Integer limit)
limit
- public ApprovalRequest.Action getApprovalActionType()
public String getApprovalComments()
public String getApprovalContextActorId()
public String getApprovalContextId()
public String getApprovalProcessDefinitionNameOrId()
public boolean isApprovalSkipEntryCriteria()
public void setApprovalActionType(ApprovalRequest.Action actionType)
actionType
- public void setApprovalComments(String comments)
comments
- public void setApprovalContextActorId(String contextActorId)
contextActorId
- public void setApprovalContextId(String contextId)
contextId
- public void setApprovalNextApproverIds(List<String> nextApproverIds)
nextApproverIds
- public void setApprovalNextApproverIds(String nextApproverId)
nextApproverIds
- public void setApprovalProcessDefinitionNameOrId(String processDefinitionNameOrId)
processDefinitionNameOrId
- public void setApprovalSkipEntryCriteria(boolean skipEntryCriteria)
skipEntryCriteria
- public NotFoundBehaviour getNotFoundBehaviour()
public void setNotFoundBehaviour(NotFoundBehaviour notFoundBehaviour)
NotFoundBehaviour.NULL
or should a
exception be signaled on the exchange NotFoundBehaviour.EXCEPTION
- the default.Apache Camel