Class SalesforceEndpointConfig
java.lang.Object
org.apache.camel.component.salesforce.SalesforceEndpointConfig
- All Implemented Interfaces:
Cloneable
Salesforce Endpoint configuration.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final long
static final int
static final long
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final long
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()
long
getJobId()
getLimit()
long
com.fasterxml.jackson.databind.ObjectMapper
int
Type of deserialization for Pub/Sub API eventsClass to deserialize Pub/Sub API events toReplayPreset for Pub/Sub APIboolean
boolean
boolean
boolean
void
setAllOrNone
(boolean allOrNone) void
setApexMethod
(String apexMethod) APEX method namevoid
setApexQueryParams
(Map<String, Object> apexQueryParams) Query params for APEX methodvoid
setApexUrl
(String apexUrl) APEX method URLvoid
setApiVersion
(String apiVersion) Salesforce API 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
(String nextApproverId) If the process requires specification of the next approval, the ID of the user to be assigned the next request.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
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 IDvoid
setCompositeMethod
(String compositeMethod) Composite (raw) method.void
setContentType
(ContentType contentType) Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSVvoid
setDefaultReplayId
(Long defaultReplayId) Default replayId setting if no value is found ininitialReplayIdMap
void
setFallBackReplayId
(Long fallBackReplayId) ReplayId to fall back to after an Invalid Replay Id responsevoid
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 IDvoid
Bulk API Job IDvoid
Limit on number of returned records.void
setLocator
(String locator) Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.void
setMaxBackoff
(long maxBackoff) Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.void
setMaxRecords
(Integer maxRecords) The maximum number of records to retrieve per set of results for a Bulk 2.0 Query.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, WHEREvoid
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
setPkChunking
(Boolean pkChunking) Use PK Chunking.void
setPkChunkingChunkSize
(Integer pkChunkingChunkSize) Chunk size for use with PK Chunking.void
setPkChunkingParent
(String pkChunkingParent) Specifies the parent object when you're enabling PK chunking for queries on sharing objects.void
setPkChunkingStartRow
(String pkChunkingStartRow) Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk.void
setPubSubBatchSize
(int pubSubBatchSize) void
setPubSubDeserializeType
(PubSubDeserializeType pubSubDeserializeType) void
setPubSubPojoClass
(String pubSubPojoClass) void
setQueryLocator
(String queryLocator) Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call.void
setRawHttpHeaders
(String rawHttpHeaders) Comma separated list of message headers to include as HTTP parameters for Raw operation.void
setRawMethod
(String rawMethod) HTTP method to use for the Raw operationvoid
setRawPath
(String rawPath) The portion of the endpoint URL after the domain name.void
setRawPayload
(boolean rawPayload) Use raw payloadString
for request and response (either JSON or XML depending onformat
), instead of DTOs, false by defaultvoid
setRawQueryParameters
(String rawQueryParameters) Comma separated list of message headers to include as query parameters for Raw operation.void
setReplayPreset
(ReplayPreset replayPreset) void
setReportId
(String reportId) Salesforce1 Analytics report Idvoid
setReportMetadata
(ReportMetadata reportMetadata) Salesforce1 Analytics report metadata for filteringvoid
setResultId
(String resultId) Bulk API Result IDvoid
setSObjectBlobFieldName
(String sObjectBlobFieldName) SObject blob field namevoid
setSObjectClass
(String sObjectClass) Fully qualified SObject class name, usually generated using camel-salesforce-maven-pluginvoid
setSObjectFields
(String sObjectFields) SObject fields to retrievevoid
setSObjectId
(String sObjectId) SObject ID if required by APIvoid
setSObjectIdName
(String sObjectIdName) SObject external ID field namevoid
setSObjectIdValue
(String sObjectIdValue) SObject external ID field valuevoid
setSObjectName
(String sObjectName) SObject name if required or supported by APIvoid
setSObjectQuery
(String sObjectQuery) Salesforce SOQL query stringvoid
setSObjectSearch
(String sObjectSearch) Salesforce SOSL search stringvoid
setStreamQueryResult
(Boolean streamQueryResult) If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages.void
setUpdateTopic
(boolean updateTopic) Whether to update an existing Push Topic when using the Streaming API, defaults to false
-
Field Details
-
DEFAULT_VERSION
- See Also:
-
API_VERSION
- See Also:
-
FORMAT
- See Also:
-
RAW_PAYLOAD
- See Also:
-
SOBJECT_NAME
- See Also:
-
SOBJECT_ID
- See Also:
-
SOBJECT_IDS
- See Also:
-
SOBJECT_FIELDS
- See Also:
-
SOBJECT_EXT_ID_NAME
- See Also:
-
SOBJECT_EXT_ID_VALUE
- See Also:
-
SOBJECT_BLOB_FIELD_NAME
- See Also:
-
SOBJECT_CLASS
- See Also:
-
SOBJECT_QUERY
- See Also:
-
STREAM_QUERY_RESULT
- See Also:
-
SOBJECT_SEARCH
- See Also:
-
APEX_METHOD
- See Also:
-
APEX_URL
- See Also:
-
COMPOSITE_METHOD
- See Also:
-
LIMIT
- See Also:
-
ALL_OR_NONE
- See Also:
-
APEX_QUERY_PARAM_PREFIX
- See Also:
-
CONTENT_TYPE
- See Also:
-
JOB_ID
- See Also:
-
BATCH_ID
- See Also:
-
RESULT_ID
- See Also:
-
QUERY_LOCATOR
- See Also:
-
LOCATOR
- See Also:
-
MAX_RECORDS
- See Also:
-
PK_CHUNKING
- See Also:
-
PK_CHUNKING_CHUNK_SIZE
- See Also:
-
PK_CHUNKING_PARENT
- See Also:
-
PK_CHUNKING_START_ROW
- See Also:
-
REPORT_ID
- See Also:
-
INCLUDE_DETAILS
- See Also:
-
REPORT_METADATA
- See Also:
-
INSTANCE_ID
- See Also:
-
DEFAULT_REPLAY_ID
- See Also:
-
FALL_BACK_REPLAY_ID
- See Also:
-
INITIAL_REPLAY_ID_MAP
- See Also:
-
REPLAY_FROM_TIP
public static final long REPLAY_FROM_TIP- See Also:
-
REPLAY_PRESET
- See Also:
-
PUB_SUB_DESERIALIZE_TYPE
- See Also:
-
PUB_SUB_POJO_CLASS
- See Also:
-
APPROVAL
- See Also:
-
RAW_PATH
- See Also:
-
RAW_METHOD
- See Also:
-
RAW_QUERY_PARAMETERS
- See Also:
-
RAW_HTTP_HEADERS
- See Also:
-
DEFAULT_MAX_AUTHENTICATION_RETRIES
public static final int DEFAULT_MAX_AUTHENTICATION_RETRIES- See Also:
-
DEFAULT_BACKOFF_INCREMENT
public static final long DEFAULT_BACKOFF_INCREMENT- See Also:
-
DEFAULT_MAX_BACKOFF
public static final long DEFAULT_MAX_BACKOFF- See Also:
-
NOT_FOUND_BEHAVIOUR
- See Also:
-
-
Constructor Details
-
SalesforceEndpointConfig
public SalesforceEndpointConfig()
-
-
Method Details
-
copy
-
getFormat
-
setFormat
Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. -
isRawPayload
public boolean isRawPayload() -
setRawPayload
public void setRawPayload(boolean rawPayload) Use raw payloadString
for request and response (either JSON or XML depending onformat
), instead of DTOs, false by default -
getApiVersion
-
setApiVersion
Salesforce API version. -
getSObjectName
-
setSObjectName
SObject name if required or supported by API -
getSObjectId
-
setSObjectId
SObject ID if required by API -
getSObjectFields
-
setSObjectFields
SObject fields to retrieve -
getSObjectIdName
-
setSObjectIdName
SObject external ID field name -
getSObjectIdValue
-
setSObjectIdValue
SObject external ID field value -
getSObjectBlobFieldName
-
setSObjectBlobFieldName
SObject blob field name -
getSObjectClass
-
setSObjectClass
Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin -
getSObjectQuery
-
setSObjectQuery
Salesforce SOQL query string -
getSObjectSearch
-
getStreamQueryResult
-
setStreamQueryResult
If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time. -
setSObjectSearch
Salesforce SOSL search string -
getApexMethod
-
setApexMethod
APEX method name -
getApexUrl
-
setApexUrl
APEX method URL -
getApexQueryParams
-
setApexQueryParams
Query params for APEX method -
getCompositeMethod
-
setCompositeMethod
Composite (raw) method. -
isAllOrNone
public boolean isAllOrNone() -
setAllOrNone
public void setAllOrNone(boolean allOrNone) -
getApproval
-
setApproval
The approval request for Approval API.- Parameters:
approval
-
-
getContentType
-
setContentType
Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV -
getJobId
-
setJobId
Bulk API Job ID -
getBatchId
-
setBatchId
Bulk API Batch ID -
getResultId
-
setResultId
Bulk API Result ID -
isUpdateTopic
public boolean isUpdateTopic() -
getQueryLocator
-
setQueryLocator
Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records. -
getLocator
-
setLocator
Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job. -
getMaxRecords
-
setMaxRecords
The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. -
getPkChunking
-
setPkChunking
Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. -
getPkChunkingChunkSize
-
setPkChunkingChunkSize
Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. -
getPkChunkingParent
-
setPkChunkingParent
Specifies the parent object when you're enabling PK chunking for queries on sharing objects. The chunks are based on the parent object's records rather than the sharing object's records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported. -
getPkChunkingStartRow
-
setPkChunkingStartRow
Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches. -
setUpdateTopic
public void setUpdateTopic(boolean updateTopic) Whether to update an existing Push Topic when using the Streaming API, defaults to false -
getNotifyForFields
-
setNotifyForFields
Notify for fields, options are ALL, REFERENCED, SELECT, WHERE -
getNotifyForOperations
-
setNotifyForOperations
Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0) -
getNotifyForOperationCreate
-
setNotifyForOperationCreate
Notify for create operation, defaults to false (API version >= 29.0) -
getNotifyForOperationUpdate
-
setNotifyForOperationUpdate
Notify for update operation, defaults to false (API version >= 29.0) -
getNotifyForOperationDelete
-
setNotifyForOperationDelete
Notify for delete operation, defaults to false (API version >= 29.0) -
getNotifyForOperationUndelete
-
setNotifyForOperationUndelete
Notify for un-delete operation, defaults to false (API version >= 29.0) -
getReportId
-
setReportId
Salesforce1 Analytics report Id -
getIncludeDetails
-
setIncludeDetails
Include details in Salesforce1 Analytics report, defaults to false. -
getReportMetadata
-
setReportMetadata
Salesforce1 Analytics report metadata for filtering -
getInstanceId
-
setInstanceId
Salesforce1 Analytics report execution instance ID -
setHttpClient
Custom Jetty Http Client to use to connect to Salesforce. -
getHttpClient
-
getObjectMapper
public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper() -
getBackoffIncrement
public long getBackoffIncrement() -
setBackoffIncrement
public void setBackoffIncrement(long backoffIncrement) Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. -
getMaxBackoff
public long getMaxBackoff() -
setMaxBackoff
public void setMaxBackoff(long maxBackoff) Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. -
setObjectMapper
public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. -
toValueMap
-
getDefaultReplayId
-
setDefaultReplayId
Default replayId setting if no value is found ininitialReplayIdMap
- Parameters:
defaultReplayId
-
-
getInitialReplayIdMap
-
setInitialReplayIdMap
Replay IDs to start from per channel name. -
getFallBackReplayId
-
setFallBackReplayId
ReplayId to fall back to after an Invalid Replay Id response -
getReplayPreset
ReplayPreset for Pub/Sub API -
setReplayPreset
-
getPubSubDeserializeType
Type of deserialization for Pub/Sub API events- Returns:
-
setPubSubDeserializeType
-
getPubSubPojoClass
Class to deserialize Pub/Sub API events to- Returns:
-
setPubSubPojoClass
-
getLimit
-
setLimit
Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation.- Parameters:
limit
-
-
getApprovalActionType
-
getApprovalComments
-
getApprovalContextActorId
-
getApprovalContextId
-
getApprovalNextApproverIds
-
getApprovalProcessDefinitionNameOrId
-
isApprovalSkipEntryCriteria
public boolean isApprovalSkipEntryCriteria() -
setApprovalActionType
Represents the kind of action to take: Submit, Approve, or Reject.- Parameters:
actionType
-
-
setApprovalComments
The comment to add to the history step associated with this request.- Parameters:
comments
-
-
setApprovalContextActorId
The ID of the submitter who’s requesting the approval record.- Parameters:
contextActorId
-
-
setApprovalContextId
The ID of the item that is being acted upon.- Parameters:
contextId
-
-
setApprovalNextApproverIds
If the process requires specification of the next approval, the ID of the user to be assigned the next request.- Parameters:
nextApproverIds
-
-
setApprovalNextApproverIds
If the process requires specification of the next approval, the ID of the user to be assigned the next request.- Parameters:
nextApproverId
-
-
setApprovalProcessDefinitionNameOrId
The developer name or ID of the process definition.- Parameters:
processDefinitionNameOrId
-
-
setApprovalSkipEntryCriteria
public 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. If the process definition name or ID isn’t specified, this argument is ignored, and standard evaluation is followed based on process order. By default, the entry criteria isn’t skipped if it’s not set by this request.- Parameters:
skipEntryCriteria
-
-
getNotFoundBehaviour
-
setNotFoundBehaviour
Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULLNotFoundBehaviour.NULL
or should a exception be signaled on the exchangeNotFoundBehaviour.EXCEPTION
- the default. -
getRawPath
-
setRawPath
The portion of the endpoint URL after the domain name. E.g., " + "'/services/data/v52.0/sobjects/Account/'- Parameters:
rawPath
- the path
-
getRawMethod
-
setRawMethod
HTTP method to use for the Raw operation- Parameters:
rawMethod
- http method
-
getRawQueryParameters
-
setRawQueryParameters
Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically.- Parameters:
rawQueryParameters
-
-
getRawHttpHeaders
-
setRawHttpHeaders
Comma separated list of message headers to include as HTTP parameters for Raw operation. -
getPubSubBatchSize
public int getPubSubBatchSize() -
setPubSubBatchSize
public void setPubSubBatchSize(int pubSubBatchSize)
-