111.3. 组件选项

apexMethod (common)

APEX 方法名称。

字符串

apexQueryParams (common)

APEX 方法的查询参数。

Map

apiVersion (common)

Salesforce API 版本。

53.0

字符串

backoffIncrement (common)

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

1000

long

batchId (common)

批量 API 批处理 ID。

字符串

ContentType ( common)

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

Enum 值：

ContentType

defaultReplayId (common)

如果 initialReplayIdMap 中没有值，则默认 replayId 设置。

-1

Long

fallBackReplayId (common)

ReplayId 在 Invalid Replay Id 响应后回退到。

-1

Long

format (common)

用于 Salesforce API 调用的有效负载格式(JSON 或 XML)默认为 JSON。自 Camel 3.12 起，此选项仅适用于 Raw 操作。

Enum 值：

PayloadFormat

httpclient ( common)

自定义 Jetty Http Client 用于连接到 Salesforce.

SalesforceHttpClient

httpClientConnectionTimeout (common)

连接到 Salesforce 服务器时 HttpClient 使用的连接超时。

60000

long

httpClientIdleTimeout (common)

当等待来自 Salesforce 服务器的响应时，HttpClient 使用的超时。

10000

long

httpMaxContentLength (common)

HTTP 响应的最大内容长度。

整数

httpRequestBufferSize (common)

HTTP 请求缓冲区大小。对于大型 SOQL 查询，可能需要增加。

8192

整数

includeDetails (common)

在 Salesforce1 Analytics 报告中包含详情，默认为 false。

布尔值

initialReplayIdMap (common)

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

Map

instanceId (common)

Salesforce1 Analytics 报告执行实例 ID。

字符串

jobId (common)

批量 API 作业 ID。

字符串

Limit (common)

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

整数

Locator (common)

salesforce Bulk 2.0 API 提供的定位器用于获取 Query 作业的结果。

字符串

maxBackoff (common)

Streaming 连接重启尝试的最大 backoff 间隔，超过 CometD auto-reconnect。

30000

long

maxRecords (common)

对于 Bulk 2.0 Query，用于检索每个结果的最大记录数。请求仍会受到大小限制。如果您正在处理大量查询结果，则在从 Salesforce 接收所有数据前可能会遇到超时。要防止超时，请在 maxRecords 参数中指定您的客户端期望接收的最大记录数。这会将结果分成较小的集合，这个值作为最大大小。

整数

notFoundBehaviour (common)

设置从 Salesforce API 接收的 404 not found 状态。如果正文被设置为 NULL NotFoundBehaviour#NULL，或者应该在交换上发送异常 NotFoundBehaviour#EXCEPTION - 默认值。

Enum 值：

例外

NotFoundBehaviour

notifyForFields (common)

通知字段，选项为 ALL, REFERENCED, SELECT, WHERE。

Enum 值：

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)。

Enum 值：

NotifyForOperationsEnum

notifyForOperationUndelete (common)

通知取消删除操作，默认为 false (API version = 29.0)。

布尔值

notifyForOperationUpdate (common)

通知更新操作，默认为 false (API version = 29.0)。

布尔值

ObjectMapper ( common)

自定义 Jackson ObjectMapper，以便在序列化/取消调试 Salesforce 对象时使用。

ObjectMapper

packages (common)

在哪些软件包中生成了 DTO 类。通常，使用 camel-salesforce-maven-plugin 生成类。如果使用生成的 DTOs 进行设置，以获取在 parameters/header 值中使用短 SObject 名称的好处。可以使用逗号分隔多个软件包。

字符串

pkChunking (common)

使用 PK Chunking。仅用于原始 Bulk API。如果需要，批量 2.0 API 会自动执行 PK 块。

布尔值

pkChunkingChunkSize (common)

用于 PK Chunking 的块大小。如果未指定，salesforce 默认为 100,000。最大大小为 250,000。

整数

pkChunkingParent (common)

当您启用 PK 块对共享对象查询时，指定父对象。块基于父对象的记录，而不是共享对象的记录。例如，在 AccountShare 上查询时，将 Account 指定为父对象。只要支持父对象，支持 PK 块进行共享对象。

字符串

pkChunkingStartRow (common)

指定用作第一个块的低边界的 15 个字符或 18 个字符记录 ID。在重启批处理间失败的作业时，使用此参数指定起始 ID。

字符串

queryLocator (common)

当查询结果超过单个调用中检索的记录数时，salesforce 提供的查询查找器可用。在后续调用中使用这个值来检索额外记录。

字符串

rawPayload (common)

使用原始有效负载字符串进行请求和响应(JSON 或 XML，具体取决于格式)，而不是 DTOs，默认为 false。

false

布尔值

reportId (common)

Salesforce1 Analytics 报告 Id.

字符串

reportMetadata (common)

Salesforce1 Analytics 报告元数据以进行过滤。

ReportMetadata

resultId (common)

批量 API 结果 ID。

字符串

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

布尔值

config (common (advanced))

全局端点配置 - 用于设置适用于所有端点的值。

SalesforceEndpointConfig

httpClientProperties (common (advanced))

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

Map

longPollingTransportProperties (common (advanced))

用于设置由 streaming api 使用的 LongPollingTransport (CometD)使用的任何属性。

Map

workerPoolMaxSize (common (advanced))

用于处理 HTTP 响应的线程池的最大大小。

20

int

workerPoolSize (common (advanced))

用于处理 HTTP 响应的线程池的大小。

10

int

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序，这意味着当消费者试图选择传入消息或类似信息时发生异常，现在将作为消息处理并由路由 Error Handler 处理。默认情况下，使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况，该处理程序将被记录在 WARN 或 ERROR 级别，并忽略。

false

布尔值

allOrNone (producer)

复合 API 选项指示在没有任何成功时回滚所有记录。

false

布尔值

apexUrl (producer)

APEX 方法 URL。

字符串

compositeMethod (producer)

复合（原始）方法。

字符串

lazyStartProducer (producer)

生成者是否应懒惰启动 （在第一个消息中）。通过懒惰启动，您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动，并导致路由启动失败。通过懒惰启动，启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意，在处理第一个消息时，创建并启动生成者可能需要稍等时间，并延长处理的总处理时间。

false

布尔值

rawHttpHeaders (producer)

以逗号分隔的消息标头列表，以作为 Raw 操作的 HTTP 参数包含在内。

字符串

rawMethod (producer)

用于 Raw 操作的 HTTP 方法。

字符串

rawPath (producer)

域名后端点 URL 的部分。E.g., '/services/data/v52.0/sobjects/Account/'.

字符串

rawQueryParameters (producer)

以逗号分隔的消息标头列表，以作为 Raw 操作的查询参数包含。不要 url-encode 值，因为这将是自动进行的。

字符串

autowiredEnabled (advanced)

是否启用自动关闭。这用于自动关闭选项（选项必须标记为 autowired），方法是在 registry 中查找查找是否有单个匹配类型实例，然后在组件上配置。这可以用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。

true

布尔值

httpProxyExcludedAddresses (proxy)

不应使用 HTTP 代理服务器的地址列表。

Set

httpProxyHost (proxy)

要使用的 HTTP 代理服务器的主机名。

字符串

httpProxyIncludedAddresses (proxy)

应该使用 HTTP 代理服务器的地址列表。

Set

httpProxyPort (proxy)

要使用的 HTTP 代理服务器的端口号。

整数

httpProxySocks4 (proxy)

如果设置为 true，则将 HTTP 代理配置为用作 SOCKS4 代理。

false

布尔值

authenticationType (security)

要使用的显式验证方法，USERNAME_PASSWORD、REFRESH_TOKEN 或 JWT 之一。Salesforce 组件可以自动决定使用属性集的身份验证方法，设置此属性以消除任何不确定性。

Enum 值：

AuthenticationType

clientId (security)

必需 在 Salesforce 实例设置中配置的连接应用程序的 OAuth 消费者密钥。通常，需要配置一个连接的应用程序，但可以通过安装软件包来提供。

字符串

clientSecret (security)

在 Salesforce 实例设置中配置的连接应用程序的 OAuth 消费者 Secret。

字符串

httpProxyAuthUri (security)

用于针对 HTTP 代理服务器进行身份验证，需要与代理服务器的 URI 匹配，以便 httpProxyUsername 和 httpProxyPassword 用于身份验证。

字符串

httpProxyPassword (security)

用于对 HTTP 代理服务器进行身份验证的密码。

字符串

httpProxyRealm (security)

代理服务器的域，用于针对 HTTP 代理服务器抢占的 Basic/Digest 身份验证方法。

字符串

httpProxySecure (security)

如果设置为 false，则禁用访问 HTTP 代理时使用 TLS。

true

布尔值

httpProxyUseDigestAuth (security)

如果设置为 true Digest 身份验证，则在向 HTTP 代理进行身份验证时将使用，否则将使用基本授权方法。

false

布尔值

httpProxyUsername (security)

用于对 HTTP 代理服务器进行身份验证的用户名。

字符串

instanceUrl (security)

身份验证后使用的 Salesforce 实例的 URL，默认从 Salesforce 接收成功身份验证。

字符串

JWTAudience (security)

使用 OAuth JWT 流时用于 Audience 声明(aud)的值。如果没有设置，将使用登录 URL，这在大多数情形中都是合适的。

字符串

keystore (security)

OAuth JWT 流中使用的密钥存储参数。KeyStore 应该只包含一个带有私钥和证书的条目。salesforce 不验证证书链，因此这可轻松是自签名证书。确保您将证书上传到对应的连接应用程序。

KeyStoreParameters

lazyLogin (security)

如果设置为 true，则组件可以在组件开始时向 Salesforce 进行身份验证。您通常会将其设置为 （默认）false，并立即了解任何身份验证问题。

false

布尔值

loginConfig (security)

一个嵌套 Bean 中的所有身份验证配置，也会直接在组件上设置所有属性。

SalesforceLoginConfig

loginUrl (security)

用于身份验证的 Salesforce 实例 所需的 URL 默认设置为 https://login.salesforce.com。

https://login.salesforce.com

字符串

password (security)

OAuth 流中使用的密码，以获取访问令牌的访问权限。易于开始使用密码 OAuth 流，但通常应该避免它，因为它比其他流的安全要低。确保使用安全令牌时将安全令牌附加到密码末尾。

字符串

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 应用程序。

字符串

sslContextParameters (security)

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

SSLContextParameters

useGlobalSslContextParameters (security)

启用使用全局 SSL 上下文参数。

false

布尔值

用户名 （安全性）

OAuth 流中使用的用户名，以获取访问令牌的访问权限。易于开始使用密码 OAuth 流，但通常应该避免它，因为它比其他流的安全要低。

字符串