54.21. Spring Boot 自動設定
Spring Boot で salesforce を使用する場合は、自動設定をサポートするために次の Maven 依存関係を使用してください。
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-salesforce-starter</artifactId> </dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-salesforce-starter</artifactId>
</dependency>
コンポーネントは、以下に記載される 91 のオプションをサポートします。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
camel.component.salesforce.all-or-none | 失敗したレコードがある場合にすべてのレコードをロールバックすることを示す複合 API オプション。 | false | Boolean |
camel.component.salesforce.apex-method | APEX メソッド名。 | String | |
camel.component.salesforce.apex-query-params | APEX メソッドのクエリーパラメーター。 | Map | |
camel.component.salesforce.apex-url | APEX メソッドの URL。 | String | |
camel.component.salesforce.api-version | Salesforce API バージョン。 | 53.0 | String |
camel.component.salesforce.authentication-type | 使用する明示的な認証方法で、USERNAME_PASSWORD、REFRESH_TOKEN、または JWT のいずれかです。Salesforce コンポーネントは、プロパティーセットから使用する認証方法を自動決定できます。このプロパティーを設定してあいまいさを排除します。 | AuthenticationType | |
camel.component.salesforce.autowired-enabled | 自動ワイヤリングが有効になっているかどうか。これは、コンポーネントで設定される一致するタイプのインスタンスが 1 つあるかどうかを検出するためにレジストリーを検索することで、自動ワイアリングオプションに使用されます (オプションは自動ワイアとマーク付けされる必要があります)。これは、JDBC データソース、JMS 接続ファクトリー、AWS クライアントなどの自動設定に使用できます。 | true | Boolean |
camel.component.salesforce.backoff-increment | CometD 自動再接続を超えた失敗に対するストリーミング接続の再起動を試みるバックオフ間隔の増分。オプションはロング型です。 | 1000 | Long |
camel.component.salesforce.batch-id | Bulk API バッチ ID。 | String | |
camel.component.salesforce.bridge-error-handler | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | Boolean |
camel.component.salesforce.client-id | Salesforce インスタンス設定で設定された接続アプリケーションの OAuth consumer キー。通常、接続アプリケーションを設定する必要がありますが、パッケージをインストールすることで提供できます。 | String | |
camel.component.salesforce.client-secret | Salesforce インスタンス設定で設定された接続アプリケーションの OAuth consumer シークレット。 | String | |
camel.component.salesforce.composite-method | 複合 (raw) 方式。 | String | |
camel.component.salesforce.config | グローバルエンドポイント設定 - すべてのエンドポイントに共通の値を設定するために使用します。オプションは org.apache.camel.component.salesforce.SalesforceEndpointConfig タイプです。 | SalesforceEndpointConfig | |
camel.component.salesforce.content-type | Bulk API コンテンツタイプ。XML、CSV、ZIP_XML、ZIP_CSV のいずれかです。 | ContentType | |
camel.component.salesforce.default-replay-id | initialReplayIdMap に値が見つからない場合のデフォルトの replayId 設定。 | -1 | Long |
camel.component.salesforce.enabled | Salesforce コンポーネントの自動設定を有効にするかどうか。これはデフォルトで有効になっています。 | Boolean | |
camel.component.salesforce.fall-back-replay-id | Invalid Replay Id レスポンスの後にフォールバックする ReplayId。 | -1 | Long |
camel.component.salesforce.format | Salesforce API 呼び出しに使用するペイロード形式 (JSON または XML) のデフォルトは JSON です。Camel 3.12 以降、このオプションは Raw 操作にのみ適用されます。 | PayloadFormat | |
camel.component.salesforce.http-client | Salesforce への接続に使用するカスタム Jetty Http クライアント。オプションは org.apache.camel.component.salesforce.SalesforceHttpClient タイプです。 | SalesforceHttpClient | |
camel.component.salesforce.http-client-connection-timeout | Salesforce サーバーへの接続時に HttpClient によって使用される接続タイムアウト。 | 60000 | Long |
camel.component.salesforce.http-client-idle-timeout | Salesforce サーバーからの応答を待機するときに HttpClient によって使用されるタイムアウト。 | 10000 | Long |
camel.component.salesforce.http-client-properties | 基になる HTTP クライアントで設定できるプロパティーを設定するために使用されます。利用可能なすべてのオプションは、SalesforceHttpClient と Jetty HttpClient のプロパティーを参照してください。 | Map | |
camel.component.salesforce.http-max-content-length | HTTP 応答のコンテンツの最大長。 | Integer | |
camel.component.salesforce.http-proxy-auth-uri | HTTP プロキシーサーバーに対する認証で使用されます。httpProxyUsername と httpProxyPassword を認証に使用するには、プロキシーサーバーの URI と一致する必要があります。 | String | |
camel.component.salesforce.http-proxy-excluded-addresses | HTTP プロキシーサーバーを使用しないアドレスのリスト。 | Set | |
camel.component.salesforce.http-proxy-host | 使用する HTTP プロキシーサーバーのホスト名。 | String | |
camel.component.salesforce.http-proxy-included-addresses | HTTP プロキシーサーバーを使用するアドレスのリスト。 | Set | |
camel.component.salesforce.http-proxy-password | HTTP プロキシーサーバーに対する認証に使用するパスワード。 | String | |
camel.component.salesforce.http-proxy-port | 使用する HTTP プロキシーサーバーのポート番号。 | Integer | |
camel.component.salesforce.http-proxy-realm | HTTP プロキシーサーバーに対するプリエンプティブ Basic/Digest 認証方式で使用される、プロキシーサーバーのレルム。 | String | |
camel.component.salesforce.http-proxy-secure | false に設定すると、HTTP プロキシーへのアクセス時に TLS の使用が無効になります。 | true | Boolean |
camel.component.salesforce.http-proxy-socks4 | true に設定すると、SOCKS4 プロキシーとして使用するように HTTP プロキシーが設定されます。 | false | Boolean |
camel.component.salesforce.http-proxy-use-digest-auth | true に設定すると、HTTP プロキシーへの認証時にダイジェスト認証が使用されます。それ以外の場合は、基本認証方法が使用されます。 | false | Boolean |
camel.component.salesforce.http-proxy-username | HTTP プロキシーサーバーに対する認証に使用するユーザー名。 | String | |
camel.component.salesforce.http-request-buffer-size | HTTP リクエストのバッファーサイズ。大規模な SOQL クエリーでは、値を増やす必要がある場合があります。 | 8192 | Integer |
camel.component.salesforce.include-details | Salesforce1 Analytics レポートに詳細を含めます。デフォルトは false です。 | Boolean | |
camel.component.salesforce.initial-replay-id-map | チャンネル名ごとに開始する Replay ID。 | Map | |
camel.component.salesforce.instance-id | Salesforce1 Analytics レポート実行インスタンス ID。 | String | |
camel.component.salesforce.instance-url | 認証後に使用される Salesforce インスタンスの URL。デフォルトでは、認証の成功時に Salesforce から受信されます。 | String | |
camel.component.salesforce.job-id | Bulk API ジョブ ID。 | String | |
camel.component.salesforce.jwt-audience | OAuth JWT フローを使用するときに Audience クレーム (aud) に使用する値。設定されていない場合は、ログイン URL が使用されますが、これはほとんどの場合に適しています。 | String | |
camel.component.salesforce.keystore | OAuth JWT フローで使用する KeyStore パラメーター。KeyStore には、秘密鍵と証明書を含むエントリーを 1 つだけ含める必要があります。Salesforce は証明書チェーンを検証しないため、これは簡単に自己署名証明書になる可能性があります。対応する接続アプリケーションに証明書をアップロードしていることを確認してください。オプションは org.apache.camel.support.jsse.KeyStoreParameters タイプです。 | KeyStoreParameters | |
camel.component.salesforce.lazy-login | true に設定すると、コンポーネントの開始時にコンポーネントが Salesforce に対して認証されなくなります。通常、これを (デフォルトの) false に設定し、早期に認証して、認証の問題をすぐに認識します。 | false | Boolean |
camel.component.salesforce.lazy-start-producer | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時に producer が失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、producer の作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | Boolean |
camel.component.salesforce.limit | 返されるレコード数の制限。一部の API に適用されます。Salesforce のドキュメントを確認してください。 | Integer | |
camel.component.salesforce.locator | クエリージョブの結果を取得するために使用する、salesforce Bulk 2.0 API によって提供されるロケーター。 | String | |
camel.component.salesforce.login-config | 1 つのネストされた Bean 内のすべての認証設定、そこに設定されたすべてのプロパティーは、コンポーネントでも直接設定できます。オプションは org.apache.camel.component.salesforce.SalesforceLoginConfig タイプです。 | SalesforceLoginConfig | |
camel.component.salesforce.login-url | 認証に使用される Salesforce インスタンスの URL。デフォルトでは次のように設定されています。 | String | |
camel.component.salesforce.long-polling-transport-properties | ストリーミング API によって使用される BayeuxClient (CometD) によって使用される LongPollingTransport で設定できる任意のプロパティーを設定するために使用されます。 | Map | |
camel.component.salesforce.max-backoff | CometD 自動再接続を超えた障害に対するストリーミング接続の再起動試行の最大バックオフ間隔。オプションはロング型です。 | 30000 | Long |
camel.component.salesforce.max-records | Bulk 2.0 クエリーの結果セットごとに取得するレコードの最大数。リクエストには引き続きサイズ制限が適用されます。非常に多数のクエリー結果を処理している場合、Salesforce からすべてのデータを受信する前にタイムアウトが発生することがあります。タイムアウトを防ぐには、クライアントが受信することを期待しているレコードの最大数を maxRecords パラメーターで指定します。これにより、この値を最大サイズとして、結果がより小さなセットに分割されます。 | Integer | |
camel.component.salesforce.not-found-behaviour | Salesforce API から受信した 404 not found ステータスの動作を設定します。本文を NULL NotFoundBehaviour#NULL に設定する必要があるか、エクスチェンジで例外を通知する必要があります NotFoundBehaviour#EXCEPTION - デフォルト。 | NotFoundBehaviour | |
camel.component.salesforce.notify-for-fields | フィールドの通知、オプションは ALL、REFERENCED、SELECT、WHERE です。 | NotifyForFieldsEnum | |
camel.component.salesforce.notify-for-operation-create | 作成操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
camel.component.salesforce.notify-for-operation-delete | 削除操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
camel.component.salesforce.notify-for-operation-undelete | 削除取り消し操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
camel.component.salesforce.notify-for-operation-update | 更新操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
camel.component.salesforce.notify-for-operations | 操作を通知します。オプションは ALL、CREATE、EXTENDED、UPDATE (API バージョン 29.0) です。 | NotifyForOperationsEnum | |
camel.component.salesforce.object-mapper | Salesforce オブジェクトをシリアライズ/デシリアライズするときに使用するカスタム Jackson ObjectMapper。オプションは com.fasterxml.jackson.databind.ObjectMapper タイプです。 | ObjectMapper | |
camel.component.salesforce.packages | 生成された DTO クラスが含まれているパッケージ。通常、クラスは camel-salesforce-maven-plugin を使用して生成されます。生成された DTO を使用して、パラメーター/ヘッダー値で短い SObject 名を使用する利点を得る場合に設定します。複数のパッケージはコンマで区切ることができます。 | String | |
camel.component.salesforce.password | アクセストークンにアクセスするために OAuth フローで使用されるパスワード。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。セキュリティートークンを使用する場合は、パスワードの末尾にセキュリティートークンを追加してください。 | String | |
camel.component.salesforce.pk-chunking | PK チャンクを使用します。元の Bulk API でのみ使用できます。Bulk 2.0 API は、必要に応じて PK チャンクを自動的に実行します。 | Boolean | |
camel.component.salesforce.pk-chunking-chunk-size | PK チャンクで使用するチャンクサイズ。指定しない場合、salesforce のデフォルトは 100,000 です。最大サイズは 250,000 です。 | Integer | |
camel.component.salesforce.pk-chunking-parent | 共有オブジェクトに対するクエリーの PK チャンクを有効にするときに、親オブジェクトを指定します。チャンクは、共有オブジェクトのレコードではなく、親オブジェクトのレコードに基づいています。たとえば、AccountShare に対してクエリーを実行する場合は、Account を親オブジェクトとして指定します。親オブジェクトがサポートされている限り、PK チャンクは共有オブジェクトでサポートされます。 | String | |
camel.component.salesforce.pk-chunking-start-row | 最初のチャンクの下限として使用する 15 文字または 18 文字のレコード ID を指定します。このパラメーターを使用して、バッチ間で失敗したジョブを再開するときに開始 ID を指定します。 | String | |
camel.component.salesforce.query-locator | クエリの結果が 1 回の呼び出しで取得できるレコード数よりも多い場合に使用する、salesforce が提供するクエリロケータです。後続の呼び出しでこの値を使用して、追加のレコードを取得します。 | String | |
camel.component.salesforce.raw-http-headers | Raw 操作の HTTP パラメーターとして含めるメッセージヘッダーのコンマ区切りリスト。 | String | |
camel.component.salesforce.raw-method | Raw 操作に使用する HTTP メソッド。 | String | |
camel.component.salesforce.raw-path | ドメイン名の後のエンドポイント URL の部分。例: '/services/data/v52.0/sobjects/Account/'。 | String | |
camel.component.salesforce.raw-payload | DTO の代わりに、リクエストとレスポンス (形式に応じて JSON または XML) に Raw ペイロード文字列を使用します。デフォルトでは false です。 | false | Boolean |
camel.component.salesforce.raw-query-parameters | Raw 操作のクエリーパラメーターとして含めるメッセージヘッダーのコンマ区切りリスト。これは自動的に行われるため、値を URL エンコードしないでください。 | String | |
camel.component.salesforce.refresh-token | 更新トークン OAuth フローですでに取得されている更新トークン。Web アプリケーションをセットアップし、コールバック URL を設定して更新トークンを受け取るか、組み込みのコールバックを使用して設定し、フローの最後で URL から refresh_token を取得する必要があります。開発組織では、Salesforce がコールバック Web アプリケーションを localhost でホストすることを許可していることに注意してください。 | String | |
camel.component.salesforce.report-id | Salesforce1 Analytics レポート ID。 | String | |
camel.component.salesforce.report-metadata | フィルタリング用の Salesforce1 Analytics レポートのメタデータ。オプションは org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata タイプです。 | ReportMetadata | |
camel.component.salesforce.result-id | Bulk API の結果 ID。 | String | |
camel.component.salesforce.s-object-blob-field-name | SObject blob フィールド名。 | String | |
camel.component.salesforce.s-object-class | 完全修飾 SObject クラス名。通常は camel-salesforce-maven-plugin を使用して生成されます。 | String | |
camel.component.salesforce.s-object-fields | 取得する SObject フィールド。 | String | |
camel.component.salesforce.s-object-id | API で必要な場合は SObject ID。 | String | |
camel.component.salesforce.s-object-id-name | sObject 外部 ID 項目名。 | String | |
camel.component.salesforce.s-object-id-value | sObject 外部 ID 項目の値。 | String | |
camel.component.salesforce.s-object-name | API で必要またはサポートされている場合の sObject 名。 | String | |
camel.component.salesforce.s-object-query | Salesforce SOQL クエリー文字列。 | String | |
camel.component.salesforce.s-object-search | Salesforce SOSL 検索文字列。 | String | |
camel.component.salesforce.ssl-context-parameters | 使用する SSL パラメーター。使用可能なすべてのオプションは、SSLContextParameters クラスを参照してください。オプションは org.apache.camel.support.jsse.SSLContextParameters タイプです。 | SSLContextParameters | |
camel.component.salesforce.update-topic | ストリーミング API の使用時に既存のプッシュトピックを更新するかどうか。デフォルトは false です。 | false | Boolean |
camel.component.salesforce.use-global-ssl-context-parameters | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | Boolean |
camel.component.salesforce.user-name | アクセストークンにアクセスするために OAuth フローで使用されるユーザー名。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。 | String | |
camel.component.salesforce.worker-pool-max-size | HTTP 応答の処理に使用されるスレッドプールの最大サイズ。 | 20 | Integer |
camel.component.salesforce.worker-pool-size | HTTP 応答の処理に使用されるスレッドプールのサイズ。 | 10 | Integer |