289.15. オプション
Salesforce コンポーネントは、以下に示す 31 個のオプションをサポートしています。
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| authenticationType (security) | 使用する明示的な認証方法で、USERNAME_PASSWORD、REFRESH_TOKEN、または JWT のいずれかです。Salesforce コンポーネントは、プロパティーセットから使用する認証方法を自動決定できます。このプロパティーを設定してあいまいさを排除します。 | AuthenticationType | |
| loginConfig (security) | 1 つのネストされた Bean 内のすべての認証設定、そこに設定されたすべてのプロパティーは、コンポーネントでも直接設定できます | SalesforceLoginConfig | |
| instanceUrl (security) | 認証後に使用される Salesforce インスタンスの URL。デフォルトでは、認証の成功時に Salesforce から受信されます | String | |
| loginUrl (security) | 認証に使用される Salesforce インスタンスの 必須 URL。デフォルトでは https://login.salesforce.com に設定されています | String | |
| clientId (security) | Salesforce インスタンス設定で設定された接続アプリケーションの 必須 OAuth consumer キー。通常、接続アプリケーションを設定する必要がありますが、パッケージをインストールすることで提供できます。 | String | |
| clientSecret (security) | Salesforce インスタンス設定で設定された接続アプリケーションの OAuth consumer シークレット。 | String | |
| keystore (security) | OAuth JWT フローで使用する KeyStore パラメーター。KeyStore には、秘密鍵と証明書を含むエントリーを 1 つだけ含める必要があります。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 がコールバック Web アプリケーションを localhost でホストすることを許可していることに注意してください。 | String | |
| userName (security) | アクセストークンにアクセスするために OAuth フローで使用されるユーザー名。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。 | String | |
| password (security) | アクセストークンにアクセスするために OAuth フローで使用されるパスワード。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。セキュリティートークンを使用する場合は、パスワードの末尾にセキュリティートークンを追加してください。 | String | |
| lazyLogin (security) | true に設定すると、コンポーネントの開始時にコンポーネントが Salesforce に対して認証されなくなります。通常、これを (デフォルトの) false に設定し、早期に認証して、認証の問題をすぐに認識します。 | false | boolean |
| config (common) | グローバルエンドポイント設定 - すべてのエンドポイントに共通の値を設定するために使用します | SalesforceEndpoint 設定 | |
| httpClientProperties (common) | 基になる HTTP クライアントで設定できるプロパティーを設定するために使用されます。利用可能なすべてのオプションは、SalesforceHttpClient と Jetty HttpClient のプロパティーを参照してください。 | Map | |
| longPollingTransport Properties (common) | ストリーミング API によって使用される BayeuxClient (CometD) によって使用される LongPollingTransport で設定できる任意のプロパティーを設定するために使用されます | Map | |
| sslContextParameters (security) | 使用する SSL パラメーター。使用可能なすべてのオプションは、SSLContextParameters クラスを参照してください。 | SSLContextParameters | |
| useGlobalSslContext Parameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします | false | boolean |
| httpProxyHost (proxy) | 使用する HTTP プロキシーサーバーのホスト名。 | String | |
| httpProxyPort (proxy) | 使用する HTTP プロキシーサーバーのポート番号。 | Integer | |
| httpProxyUsername (security) | HTTP プロキシーサーバーに対する認証に使用するユーザー名。 | String | |
| httpProxyPassword (security) | HTTP プロキシーサーバーに対する認証に使用するパスワード。 | String | |
| isHttpProxySocks4 (proxy) | true に設定すると、SOCKS4 プロキシーとして使用するように HTTP プロキシーが設定されます。 | false | boolean |
| isHttpProxySecure (security) | false に設定すると、HTTP プロキシーへのアクセス時に TLS の使用が無効になります。 | true | boolean |
| httpProxyIncluded Addresses (proxy) | HTTP プロキシーサーバーを使用するアドレスのリスト。 | Set | |
| httpProxyExcluded Addresses (proxy) | HTTP プロキシーサーバーを使用しないアドレスのリスト。 | Set | |
| httpProxyAuthUri (security) | HTTP プロキシーサーバーに対する認証で使用されます。httpProxyUsername と httpProxyPassword を認証に使用するには、プロキシーサーバーの URI と一致する必要があります。 | String | |
| httpProxyRealm (security) | HTTP プロキシーサーバーに対するプリエンプティブ Basic/Digest 認証方式で使用される、プロキシーサーバーのレルム。 | String | |
| httpProxyUseDigest Auth (security) | true に設定すると、HTTP プロキシーへの認証時にダイジェスト認証が使用されます。それ以外の場合は、基本認証方法が使用されます | false | boolean |
| packages (common) | 生成された DTO クラスが含まれているパッケージ。通常、クラスは camel-salesforce-maven-plugin を使用して生成されます。生成された DTO を使用して、パラメーター/ヘッダー値で短い SObject 名を使用する利点を得る場合に設定します。 | String[] | |
| queryLocator (common) | クエリの結果が 1 回の呼び出しで取得できるレコード数よりも多い場合に使用する、salesforce が提供するクエリロケータです。後続の呼び出しでこの値を使用して、追加のレコードを取得します。 | String | |
| jobType (common) | 指定されたジョブタイプに一致するジョブに関する情報のみを取得します。以下の値が使用できます。
| String | |
| resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
Salesforce エンドポイントは、URI 構文を使用して設定されます。
salesforce:operationName:topicName
パスおよびクエリーパラメーターを使用します。
289.15.1. パスパラメーター (2 個のパラメーター):
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| operationName | 使用する操作。59 個の列挙型があり、値は次のいずれかになります。getVersions、getResources、getGlobalObjects、getBasicInfo、getDescription、getSObject、createSObject、updateSObject、deleteSObject、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、bulk2CreateQueryJob、bulk2GetQueryJob、bulk2GetAllQueryJobs、bulk2GetQueryJobResults、bulk2AbortQueryJob、bulk2DeleteQueryJob | OperationName | |
| topicName | 使用するトピックの名前 | String |
289.15.2. クエリーパラメーター (46 個のパラメーター):
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| apexMethod (common) | APEX メソッド名 | String | |
| apexQueryParams (common) | APEX メソッドのクエリーパラメーター | Map | |
| apexUrl (common) | APEX メソッドの URL | String | |
| apiVersion (common) | Salesforce API バージョン、デフォルトは SalesforceEndpointConfig.DEFAULT_VERSION | String | |
| backoffIncrement (common) | CometD 自動再接続を超えた失敗に対するストリーミング接続の再起動を試みるバックオフ間隔の増分。 | long | |
| batchId (common) | Bulk API バッチ ID | String | |
| contentType (common) | Bulk API コンテンツタイプ。XML、CSV、ZIP_XML、ZIP_CSV のいずれかです | ContentType | |
| defaultReplayId (common) | initialReplayIdMap に値が見つからない場合のデフォルトの replayId 設定 | Long | |
| format (common) | Salesforce API 呼び出しに使用するペイロード形式 (JSON または XML) のデフォルトは JSON です | PayloadFormat | |
| httpClient (common) | Salesforce への接続に使用するカスタム Jetty Http クライアント。 | SalesforceHttpClient | |
| includeDetails (common) | Salesforce1 Analytics レポートに詳細を含めます。デフォルトは false です。 | Boolean | |
| initialReplayIdMap (common) | チャンネル名ごとに開始する Replay ID。 | Map | |
| instanceId (common) | Salesforce1 Analytics レポート実行インスタンス ID | String | |
| jobId (common) | Bulk API ジョブ ID | String | |
| jobType (common) | 指定されたジョブタイプに一致するジョブに関する情報のみを取得します。以下の値が使用できます。
| String | |
| limit (common) | 返されるレコード数の制限。一部の API に適用されます。Salesforce のドキュメントを確認してください。 | Integer | |
| maxBackoff (common) | CometD 自動再接続を超えた障害に対するストリーミング接続の再起動試行の最大バックオフ間隔。 | 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 バージョン = 29.0) です | Boolean | |
| notifyForOperationDelete (common) | 削除操作を通知します。デフォルトは false (API バージョン = 29.0) です | Boolean | |
| notifyForOperations (common) | 操作を通知します。オプションは ALL、CREATE、EXTENDED、UPDATE (API バージョン 29.0) です | NotifyForOperations 列挙 | |
| notifyForOperationUndelete (common) | 削除取り消し操作を通知します。デフォルトは false (API バージョン = 29.0) です | Boolean | |
| notifyForOperationUpdate (common) | 更新操作を通知します。デフォルトは false (API バージョン = 29.0) です | Boolean | |
| objectMapper (common) | Salesforce オブジェクトをシリアライズ/デシリアライズするときに使用するカスタム Jackson ObjectMapper。 | ObjectMapper | |
| queryLocator (common) | クエリの結果が 1 回の呼び出しで取得できるレコード数よりも多い場合に使用する、salesforce が提供するクエリロケータです。後続の呼び出しでこの値を使用して、追加のレコードを取得します。 | String | |
| rawPayload (common) | DTO の代わりに、リクエストとレスポンス (形式に応じて JSON または XML) に Raw ペイロード文字列を使用します。デフォルトでは false です | false | boolean |
| reportId (common) | Salesforce1 Analytics レポート ID | String | |
| reportMetadata (common) | フィルタリング用の Salesforce1 Analytics レポートのメタデータ | ReportMetadata | |
| resultId (common) | Bulk API の結果 ID | String | |
| serializeNulls (common) | 指定された DTO の NULL 値を空 (NULL) 値でシリアル化する必要があります。これは、JSON データ形式のみに影響します。 | false | boolean |
| sObjectBlobFieldName (common) | SObject blob フィールド名 | String | |
| sObjectClass (common) | 完全修飾 SObject クラス名。通常は camel-salesforce-maven-plugin を使用して生成されます | String | |
| sObjectFields (common) | 取得する SObject フィールド | String | |
| sObjectId (common) | API で必要な場合は SObject ID | String | |
| sObjectIdName (common) | sObject 外部 ID 項目名 | String | |
| sObjectIdValue (common) | sObject 外部 ID 項目の値 | String | |
| sObjectName (common) | API で必要またはサポートされている場合の sObject 名 | String | |
| sObjectQuery (common) | Salesforce SOQL クエリー文字列 | String | |
| sObjectSearch (common) | Salesforce SOSL 検索文字列 | String | |
| updateTopic (common) | ストリーミング API の使用時に既存のプッシュトピックを更新するかどうか。デフォルトは false です | false | boolean |
| bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
| replayId (consumer) | サブスクライブ時に使用する replayId 値 | Long | |
| exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
| exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
| synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
