289.15. 选项
Salesforce 组件支持 31 个选项,如下所列。
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
authenticationType (security) | 要使用的显式验证方法,USERNAME_PASSWORD、REFRESH_TOKEN 或 JWT 之一。Salesforce 组件可以自动决定使用属性集的身份验证方法,设置此属性以消除任何不确定性。 | AuthenticationType | |
loginConfig (security) | 一个嵌套 Bean 中的所有身份验证配置,也会直接在组件上设置所有属性 | SalesforceLoginConfig | |
instanceUrl (security) | 身份验证后使用的 Salesforce 实例的 URL,默认从 Salesforce 接收成功身份验证 | 字符串 | |
loginUrl (security) | 用于身份验证的 Salesforce 实例 所需的 URL,默认设置为 https://login.salesforce.com | 字符串 | |
clientId (security) | 必需 在 Salesforce 实例设置中配置的连接应用程序的 OAuth 消费者密钥。通常,需要配置一个连接的应用程序,但可以通过安装软件包来提供。 | 字符串 | |
clientSecret (security) | 在 Salesforce 实例设置中配置的连接应用程序的 OAuth 消费者 Secret。 | 字符串 | |
keystore (security) | OAuth JWT 流中使用的密钥存储参数。KeyStore 应该只包含一个带有私钥和证书的条目。salesforce 不验证证书链,因此这可轻松是自签名证书。确保您将证书上传到对应的连接应用程序。 | KeyStoreParameters | |
refreshToken (security) | 刷新令牌已在刷新令牌 OAuth 流中获取。需要设置 Web 应用并配置回调 URL 以接收刷新令牌,或使用 https://login.salesforce.com/services/oauth2/success 或 https://test.salesforce.com/services/oauth2/success 的内置回调进行配置,然后在流结束时从 URL 检索 refresh_token。请注意,在开发过程中,Salesforce 允许在 localhost 托管回调 Web 应用程序。 | 字符串 | |
userName (security) | OAuth 流中使用的用户名,以获取访问令牌的访问权限。易于开始使用密码 OAuth 流,但通常应该避免它,因为它比其他流的安全要低。 | 字符串 | |
password (security) | OAuth 流中使用的密码,以获取访问令牌的访问权限。易于开始使用密码 OAuth 流,但通常应该避免它,因为它比其他流的安全要低。确保使用安全令牌时将安全令牌附加到密码末尾。 | 字符串 | |
lazyLogin (security) | 如果设置为 true,则组件可以在组件开始时向 Salesforce 进行身份验证。您将通常将其设置为 (默认)false,并立即了解任何身份验证问题。 | false | 布尔值 |
config (common) | 全局端点配置 - 用于设置适用于所有端点的值 | SalesforceEndpoint Config | |
httpClientProperties (common) | 用于设置可在底层 HTTP 客户端上配置的任何属性。查看 SalesforceHttpClient 的属性,以及所有可用选项的 Jetty HttpClient。 | Map | |
longPollingTransport Properties (common) | 用于设置可在由流 api 使用的 LongPollingTransport (CometD)使用的 LongPollingTransport 的任何属性 | Map | |
sslContextParameters (security) | 要使用的 SSL 参数,请参阅所有可用选项的 SSLContextParameters 类。 | SSLContextParameters | |
useGlobalSslContext Parameters (security) | 启用使用全局 SSL 上下文参数 | false | 布尔值 |
httpProxyHost (proxy) | 要使用的 HTTP 代理服务器的主机名。 | 字符串 | |
httpProxyPort (proxy) | 要使用的 HTTP 代理服务器的端口号。 | 整数 | |
httpProxyUsername (security) | 用于对 HTTP 代理服务器进行身份验证的用户名。 | 字符串 | |
httpProxyPassword (security) | 用于对 HTTP 代理服务器进行身份验证的密码。 | 字符串 | |
isHttpProxySocks4 (proxy) | 如果设置为 true,则将 HTTP 代理配置为用作 SOCKS4 代理。 | false | 布尔值 |
isHttpProxySecure (security) | 如果设置为 false,则禁用访问 HTTP 代理时使用 TLS。 | true | 布尔值 |
httpProxyIncluded Addresses (proxy) | 应该使用 HTTP 代理服务器的地址列表。 | Set | |
httpProxyExcluded Addresses (proxy) | 不应使用 HTTP 代理服务器的地址列表。 | Set | |
httpProxyAuthUri (security) | 用于针对 HTTP 代理服务器进行身份验证,需要与代理服务器的 URI 匹配,以便 httpProxyUsername 和 httpProxyPassword 用于身份验证。 | 字符串 | |
httpProxyRealm (security) | 代理服务器的域,用于针对 HTTP 代理服务器抢占的 Basic/Digest 身份验证方法。 | 字符串 | |
httpProxyUseDigest Auth (security) | 如果设置为 true Digest 身份验证,则在向 HTTP 代理进行身份验证时将使用,否则将使用其他基本授权方法 | false | 布尔值 |
packages (common) | 在哪些软件包中生成了 DTO 类。通常,使用 camel-salesforce-maven-plugin 生成类。如果使用生成的 DTOs 进行设置,以获取在 parameters/header 值中使用短 SObject 名称的好处。 | String[] | |
queryLocator (common) | 当查询结果超过单个调用中检索的记录数时,salesforce 提供的查询查找器可用。在后续调用中使用这个值来检索额外记录。 | 字符串 | |
jobType (common) | 仅获取有关与指定作业类型匹配的作业的信息。可能的值有:
| 字符串 | |
resolveProperty Placeholders (advanced) | 启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。 | true | 布尔值 |
Salesforce 端点使用 URI 语法进行配置:
salesforce:operationName:topicName
使用以下路径和查询参数:
289.15.1. 路径参数(2 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
operationName | 要使用的操作。有 59 enums,值可以是: getVersions, getResources, getGlobalObjects, getBasicInfo, getDescription, getSObject, createSObject, updateSObject, deleteSObject, getSObjectWithId, upsertSObject, deleteSObjectWithId, getBlobField, queryMore, queryAll, search, apexCall, recent, createJob, getJob, closeJob, abortJob, createBatch, getBatch, getAllBatches, getRequest, getResults, createBatchQuery, getQueryResultIds, getQueryResult, getRecentReports, getReportDescription, executeSyncReport, executeAsyncReport, getReportInstances, getReportResults, limits, approval, approvals, composite-tree, composite-batch, composite, bulk2GetAllJobs, bulk2CreateJob, bulk2GetJob, bulk2CreateBatch, bulk2AbortJob, bulk2DeleteJob, bulk2DeleteJob, bulk2GetSuccessfulResults, bulk2GetFailedResults, bulk2GetUnprocessedRecords, bulk2CreateQueryJob, bulk2GetQueryJob, bulk2GetAllQueryJobs, bulk2GetQueryJobResults, bulk2AbortQueryJob, bulk2DeleteQueryJob | OperationName | |
topicName | 要使用的主题名称 | 字符串 |
289.15.2. 查询参数(46 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
apexMethod (common) | APEX 方法名称 | 字符串 | |
apexQueryParams (common) | APEX 方法的查询参数 | Map | |
apexUrl (common) | APEX 方法 URL | 字符串 | |
apiVersion (common) | Salesforce API 版本,默认为 SalesforceEndpointConfig.DEFAULT_VERSION | 字符串 | |
backoffIncrement (common) | 流连接重启尝试的 backoff 间隔递增超过 CometD auto-reconnect。 | long | |
batchId (common) | 批量 API 批处理 ID | 字符串 | |
contentType (common) | 批量 API 内容类型, XML, CSV, ZIP_XML, ZIP_CSV | ContentType | |
defaultReplayId (common) | 如果 initialReplayIdMap 中没有值,则默认 replayId 设置 | Long | |
format (common) | 用于 Salesforce API 调用的有效负载格式(JSON 或 XML)默认为 JSON | PayloadFormat | |
httpClient (common) | 自定义 Jetty Http Client 用于连接到 Salesforce. | SalesforceHttpClient | |
includeDetails (common) | 在 Salesforce1 Analytics 报告中包含详情,默认为 false。 | 布尔值 | |
initialReplayIdMap (common) | 重播 ID 从每个频道名称开始。 | Map | |
instanceId (common) | Salesforce1 Analytics 报告执行实例 ID | 字符串 | |
jobId (common) | 批量 API 作业 ID | 字符串 | |
jobType (common) | 仅获取有关与指定作业类型匹配的作业的信息。可能的值有:
| 字符串 | |
limit (common) | 对返回的记录数量的限制。适用于一些 API,请查看 Salesforce 文档。 | 整数 | |
maxBackoff (common) | Streaming 连接重启尝试的最大 backoff 间隔,超过 CometD auto-reconnect。 | long | |
notFoundBehaviour (common) | 设置从 Salesforce API 接收的 404 not found 状态。如果正文被设置为 NULL NotFoundBehaviour#NULL,或者应该在交换上发送异常 NotFoundBehaviour#EXCEPTION - 默认值。 | NotFoundBehaviour | |
notifyForFields (common) | 通知字段,选项为 ALL, REFERENCED, SELECT, WHERE | NotifyForFieldsEnum | |
notifyForOperationCreate (common) | 通知创建操作,默认为 false (API version = 29.0) | 布尔值 | |
notifyForOperationDelete (common) | notify for delete 操作,默认为 false (API version = 29.0) | 布尔值 | |
notifyForOperations (common) | 通知操作,选项为 ALL、CREATE、EXTENDED、UPDATE (API 版本 29.0) | NotifyForOperations Enum | |
notifyForOperationUndelete (common) | 通知取消删除操作,默认为 false (API version = 29.0) | 布尔值 | |
notifyForOperationUpdate (common) | 通知更新操作,默认为 false (API version = 29.0) | 布尔值 | |
objectMapper (common) | 自定义 Jackson ObjectMapper,以便在序列化/取消调试 Salesforce 对象时使用。 | ObjectMapper | |
queryLocator (common) | 当查询结果超过单个调用中检索的记录数时,salesforce 提供的查询查找器可用。在后续调用中使用这个值来检索额外记录。 | 字符串 | |
rawPayload (common) | 使用原始有效负载字符串进行请求和响应(JSON 或 XML,具体取决于格式),而不是 DTOs,默认为 false | false | 布尔值 |
reportId (common) | Salesforce1 Analytics 报告 Id | 字符串 | |
reportMetadata (common) | Salesforce1 Analytics 报告元数据用于过滤 | ReportMetadata | |
resultId (common) | 批量 API 结果 ID | 字符串 | |
serializeNulls (common) | 如果给定的 DTO 的 NULL 值使用空(NULL)值进行序列化。这仅会影响 JSON 数据格式。 | false | 布尔值 |
sObjectBlobFieldName (common) | SObject blob 字段名称 | 字符串 | |
sObjectClass (common) | 完全限定的 SObject 类名称,通常使用 camel-salesforce-maven-plugin 生成 | 字符串 | |
sObjectFields (common) | 要检索的 SObject 字段 | 字符串 | |
sObjectId (common) | API 需要 SObject ID | 字符串 | |
sObjectIdName (common) | SObject 外部 ID 字段名称 | 字符串 | |
sObjectIdValue (common) | SObject external ID 字段值 | 字符串 | |
sObjectName (common) | API 需要或支持 SObject 名称 | 字符串 | |
sObjectQuery (common) | salesforce SOQL 查询字符串 | 字符串 | |
sObjectSearch (common) | salesforce SOSL 搜索字符串 | 字符串 | |
updateTopic (common) | 在使用 Streaming API 时是否要更新现有的 Push 主题,默认为 false | false | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
replayId (consumer) | 订阅时要使用的 replayId 值 | Long | |
exceptionHandler (consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
同步 (advanced) | 设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。 | false | 布尔值 |