4.2. AHC-WS オプション
AHC-WS コンポーネントは AHC コンポーネントに基づいているため、AHC コンポーネントのさまざまな設定オプションを使用できます。
AHC Websocket コンポーネントは、以下に示す 8 つのオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
client (advanced) | カスタム AsyncHttpClient を使用します。 | AsyncHttpClient | |
binding (advanced) | AHC と Camel 間のバインド方法を制御できるカスタム AhcBinding を使用します。 | AhcBinding | |
clientConfig (advanced) | カスタム com.ning.http.client.AsyncHttpClientConfig インスタンスを使用するように AsyncHttpClient を設定するには。 | AsyncHttpClientConfig | |
sslContextParameters (security) | レジストリー内の org.apache.camel.util.jsse.SSLContextParameters への参照。このオプションを設定すると、エンドポイントまたはコンポーネントレベルで clientConfig オプションを介して提供される SSL/TLS 設定オプションが上書きされることに注意してください。 | SSLContextParameters | |
allowJavaSerialized Object (advanced) | リクエストが context-type=application/x-java-serialized-object を使用するときに Java シリアライゼーションを許可するかどうか。これはデフォルトでオフになっています。これを有効にすると、Java が受信データをリクエストから Java にデシリアライズし、セキュリティー上のリスクが生じる可能性があることに注意してください。 | false | boolean |
useGlobalSslContext Parameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
headerFilterStrategy (filter) | カスタムの org.apache.camel.spi.HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルターします。 | HeaderFilterStrategy | |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
AHC Websocket エンドポイントは、URI 構文を使用して設定されます。
ahc-ws:httpUri
パスおよびクエリーパラメーターを使用します。
4.2.1. パスパラメーター (1 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
httpUri | 必須 使用する URI (例: http://hostname:port/path) | URI |
4.2.2. クエリーパラメーター (18 パラメーター)
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
bridgeEndpoint (common) | オプションが true の場合、Exchange.HTTP_URI ヘッダーは無視され、エンドポイントの URI を要求に使用します。また、throwExceptionOnFailure を false に設定して、AhcProducer がすべての障害応答を送り返すようにすることもできます。 | false | boolean |
bufferSize (common) | Camel と AHC クライアントの間でデータを転送するときに使用される初期メモリー内バッファーサイズ。 | 4096 | int |
headerFilterStrategy (common) | カスタムの HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルタリングします。 | HeaderFilterStrategy | |
throwExceptionOnFailure (common) | リモートサーバーからの応答が失敗した場合に AhcOperationFailedException の出力を無効にするオプション。これにより、HTTP ステータスコードに関係なくすべての応答を取得できます。 | true | boolean |
transferException (common) | 有効にすると、エクスチェンジがコンシューマー側で処理に失敗し、発生した例外が application/x-java-serialized-object コンテンツタイプとして応答でシリアライズされた場合に、例外がシリアライズされました (例: Jetty または Servlet Camel のコンポーネント)。プロデューサ側では、AhcOperationFailedException の代わりに、例外がデシリアライズされ、そのまま出力されます。原因となった例外はシリアライズする必要があります。これは、デフォルトでオフになっています。これを有効にすると、Java が受信データをリクエストから Java にデシリアライズし、セキュリティー上のリスクが生じる可能性があることに注意してください。 | false | boolean |
bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
sendMessageOnError (consumer) | Web ソケットリスナーがエラーを受信した場合にメッセージを送信するかどうか。 | false | boolean |
exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
connectionClose (producer) | Connection Close ヘッダーを HTTP 要求に追加する必要があるかどうかを定義します。このパラメーターはデフォルトで false です)。 | false | boolean |
cookieHandler (producer) | HTTP セッションを維持するようにクッキーハンドラーを設定します。 | CookieHandler | |
useStreaming (producer) | ストリーミングを有効にして、データを複数のテキストフラグメントとして送信します。 | false | boolean |
binding (advanced) | AHC と Camel 間のバインド方法を制御できるカスタム AhcBinding を使用します。 | AhcBinding | |
clientConfig (advanced) | カスタム com.ning.http.client.AsyncHttpClientConfig インスタンスを使用するように AsyncHttpClient を設定するには。 | AsyncHttpClientConfig | |
clientConfigOptions (advanced) | マップのキー/値を使用して AsyncHttpClientConfig を設定します。 | Map | |
synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
clientConfigRealmOptions (security) | マップのキー/値を使用して AsyncHttpClientConfig レルムを設定します。 | Map | |
sslContextParameters (security) | レジストリー内の org.apache.camel.util.jsse.SSLContextParameters への参照。この参照は、設定されている SSLContextParameters をコンポーネントレベルでオーバーライドします。JSSE 設定ユーティリティーの使用を参照してください。このオプションを設定すると、エンドポイントまたはコンポーネントレベルで clientConfig オプションを介して提供される SSL/TLS 設定オプションが上書きされることに注意してください。 | SSLContextParameters |