289.15. 选项


Salesforce 组件支持 31 个选项,如下所列。

Name描述默认值类型

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

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/successhttps://test.salesforce.com/services/oauth2/success 的内置回调进行配置,然后从流末尾的 URL 中重试 refresh_token。请注意,在开发组织中,Salesforce 允许在 localhost 处托管回调 Web 应用程序。

 

字符串

用户名 (security)

OAuth 流中使用的用户名,以获取对访问令牌的访问权限。使用密码 OAuth 流很容易,但通常应该避免它,因为它被视为不如其他流的安全性。

 

字符串

密码 (security)

OAuth 流中使用的密码,以获取对访问令牌的访问权限。使用密码 OAuth 流很容易,但通常应该避免它,因为它被视为不如其他流的安全性。如果使用,请确保将安全令牌附加到密码的末尾。

 

字符串

lazyLogin (security)

如果设置为 true,则组件可以防止组件通过启动组件向 Salesforce 进行身份验证。您通常会将其设置为 (默认) false,并提前进行身份验证,并立即了解任何身份验证问题。

false

布尔值

config (common)

全局端点配置 - 使用 设置所有端点通用的值

 

SalesforceEndpoint Config

httpClientProperties (common)

用于设置可以在底层 HTTP 客户端上配置的任何属性。查看 SalesforceHttpClient 的属性,以及适用于所有可用选项的 Jetty HttpClient。

 

Map

longPollingTransport Properties (common)

用于在流传输 api 使用的 BayeuxClient (CometD)上使用的 LongPollingTransport 上配置的任何属性

 

Map

sslContextParameters (security)

要使用的 SSL 参数,请参阅所有可用选项的 SSLContextParameters 类。

 

SSLContextParameters

useGlobalSslContext 参数 (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)

仅获取有关与指定作业类型匹配的作业信息。可能的值有:

Classic Bulk API 作业(包括查询作业和 ingest 作业)。

V2Query Bulk API 2.0 查询作业。

V2Ingest Bulk API 2.0 ingest (上传和 upsert)作业。

 

字符串

resolveProperty Placeholders (advanced)

组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。

true

布尔值

Salesforce 端点使用 URI 语法进行配置:

salesforce:operationName:topicName

使用以下路径和查询参数:

289.15.1. 路径参数(2 参数):

Name描述默认值类型

operationName

要使用的操作。有 59 enums,值可以是: getVersions, getResources, getGlobalObjects, getBasicInfo, getDescription, getSObject, createSObject, updateSObject, deleteSObject, getSObject, getSObjectWithId, upsertSObject, deleteSObjectWithId, getBlobField, query, 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, bulk2CloseJob, bulk2AbortJob, bulk2DeleteJob, bulk2GetSuccessfulResults, bulk2GetFailedResults, bulk2GetUnprocessedRecords, bulk2GetUnprocessedRecords, bulk2CreateQueryJob, bulk2GetQueryJob, bulk2GetAllQueryJobs, bulk2GetQueryJobs, bulk2AbortQueryJob, bulk2DeleteQueryJob

 

OperationName

topicName

要使用的主题的名称

 

字符串

289.15.2. 查询参数(46 参数):

Name描述默认值类型

apexMethod (common)

APEX 方法名称

 

字符串

apexQueryParams (common)

查询 APEX 方法的参数

 

Map

apexUrl (common)

APEX 方法 URL

 

字符串

apiVersion (common)

salesforce API 版本,默认为 SalesforceEndpointConfig.DEFAULT_VERSION

 

字符串

backoffIncrement (common)

对于流连接重启尝试超过 CometD auto-reconnect 的 backoff 间隔递增。

 

long

batchId (common)

批量 API 批处理 ID

 

字符串

contentType (common)

批量 API 内容类型, XML, CSV, ZIP_XML, ZIP_CSV 之一

 

ContentType

defaultReplayId (common)

如果没有在 initialReplayIdMap 中找到值,则默认 replayId 设置

 

Long

格式 (common)

用于 Salesforce API 调用的 payload 格式(JSON 或 XML)默认为 JSON

 

PayloadFormat

httpclient ( common)

自定义 Jetty Http 客户端用于连接到 Salesforce。

 

SalesforceHttpClient

includeDetails (common)

在 Salesforce1 分析报告中包括详细信息,默认为 false。

 

布尔值

initialReplayIdMap (common)

重播 ID 从每个频道名称开始。

 

Map

instanceId (common)

Salesforce1 Analytics 报告执行实例 ID

 

字符串

jobId (common)

批量 API 作业 ID

 

字符串

jobType (common)

仅获取有关与指定作业类型匹配的作业信息。可能的值有:

Classic Bulk API 作业(包括查询作业和 ingest 作业)。

V2Query Bulk API 2.0 查询作业。

V2Ingest Bulk API 2.0 ingest (上传和 upsert)作业。

 

字符串

limit (common)

返回的记录数量的限制。适用于某些 API,请查看 Salesforce 文档。

 

整数

maxBackoff (common)

Streaming connection restart attempt for failures beyond CometD auto-reconnect 的最大 backoff 间隔。

 

long

notFoundBehaviour (common)

设置从 Salesforce API 收到的 404 未找到状态的行为。如果正文设置为 NULL NotFoundBehaviour#NULL,或者应该在交换 NotFoundBehaviour CPUfreqEXCEPTION 上发送异常。

 

NotFoundBehaviour

notifyForFields (common)

notify for fields, options are ALL, REFERENCED, SELECT, WHERE

 

NotifyForFieldsEnum

notifyForOperationCreate (common)

notify 用于 create 操作,默认为 false (API version = 29.0)

 

布尔值

notifyForOperationDelete (common)

notify 用于 delete 操作,默认为 false (API version = 29.0)

 

布尔值

notifyForOperations (common)

notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API 版本 29.0)

 

NotifyForOperations Enum

notifyForOperationUndelete (common)

notify 为 un-delete 操作,默认为 false (API version = 29.0)

 

布尔值

notifyForOperationUpdate (common)

notify 用于 update 操作,默认为 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 外部 ID 字段值

 

字符串

sObjectName (common)

SObject 名称(如果 API 需要或支持)

 

字符串

sObjectQuery (common)

salesforce SOQL 查询字符串

 

字符串

sObjectSearch (common)

salesforce SOSL 搜索字符串

 

字符串

updateTopic (common)

使用 Streaming API 时是否更新现有的 Push Topic,默认为 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

同步 (高级)

设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。

false

布尔值

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.