281.2. オプション
Restlet コンポーネントは、以下に示す 23 個のオプションをサポートしています。
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| controllerDaemon (consumer) | コントローラースレッドがデーモンである必要があるかどうかを示します (JVM の終了をブロックしません)。 | Boolean | |
| controllerSleepTimeMs (consumer) | コントローラースレッドが各コントロール間でスリープする時間。 | Integer | |
| headerFilterStrategy (filter) | カスタムの org.apache.camel.spi.HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルターします。 | HeaderFilterStrategy | |
| inboundBufferSize (consumer) | メッセージを読み取るときのバッファーのサイズ。 | Integer | |
| maxConnectionsPerHost (common) | ホスト (IP アドレス) あたりの同時接続の最大数。 | Integer | |
| maxThreads (consumer) | リクエストを処理する最大スレッド。 | Integer | |
| lowThreads (consumer) | コネクターが過負荷と見なされるタイミングを決定するワーカースレッドの数。 | Integer | |
| maxTotalConnections (common) | 同時接続の合計最大数。 | Integer | |
| minThreads (consumer) | リクエストを処理するために待機しているスレッドの最小数。 | Integer | |
| outboundBufferSize (consumer) | メッセージを書き込むときのバッファーのサイズ。 | Integer | |
| persistingConnections (consumer) | 通話後に接続を維持する必要があるかどうかを示します。 | Boolean | |
| pipeliningConnections (consumer) | パイプライン接続がサポートされているかどうかを示します。 | Boolean | |
| threadMaxIdleTimeMs (consumer) | アイドル状態のスレッドが収集される前に操作を待機する時間。 | Integer | |
| useForwardedForHeader (consumer) | 一般的なプロキシーとキャッシュでサポートされている X-Forwarded-For ヘッダーを検索し、それを使用して Request.getClientAddresses() メソッドの結果を入力します。この情報は、ローカルネットワーク内の中間コンポーネントに対してのみ安全です。他のアドレスは、偽のヘッダーを設定することで簡単に変更できるため、重大なセキュリティーチェックで信頼するべきではありません。 | Boolean | |
| reuseAddress (consumer) | SO_REUSEADDR ソケットオプションを有効/無効にします。詳細については、java.io.ServerSocket#reuseAddress プロパティーを参照してください。 | Boolean | |
| maxQueued (consumer) | サービスに使用できるワーカースレッドがない場合にキューに入れることができる呼び出しの最大数。値が 0 の場合、キューは使用されず、ワーカースレッドがすぐに利用できない場合、呼び出しは拒否されます。値が -1 の場合、無制限のキューが使用され、呼び出しが拒否されることはありません。 | Integer | |
| disableStreamCache (consumer) | Restlet からの生の入力ストリームがキャッシュされるかどうかを決定します (Camel はストリームをメモリー内/ファイルへのオーバーフロー、ストリームキャッシュに読み込みます)。デフォルトでは、Camel は Restlet 入力ストリームをキャッシュして複数回の読み取りをサポートし、Camel がストリームからすべてのデータを取得できるようにします。ただし、ファイルやその他の永続ストアに直接ストリーミングするなど、生のストリームにアクセスする必要がある場合は、このオプションを true に設定できます。ストリームの複数回の読み取りをサポートするためにこのオプションが false の場合、DefaultRestletBinding は要求入力ストリームをストリームキャッシュにコピーし、それをメッセージ本文に入れます。 | false | boolean |
| port (consumer) | restlet コンシューマールートのポート番号を設定するには。これにより、これを一度設定して、これらのコンシューマーに同じポートを再利用できます。 | int | |
| synchronous (producer) | プロデューサに同期 Restlet クライアントを使用するかどうか。このオプションを true に設定すると、Restlet 同期クライアントのほうがうまく機能するように見えるため、パフォーマンスが向上する可能性があります。 | Boolean | |
| enabledConverters (advanced) | 完全なクラス名または単純なクラス名として有効にするコンバーターのリスト。空または null の場合、自動的に登録されたすべてのコンバーターが有効になります | List | |
| useGlobalSslContext Parameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
| sslContextParameters (security) | SSLContextParameters を使用してセキュリティーを設定する場合。 | SSLContextParameters | |
| resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
Restlet エンドポイントは、URI 構文を使用して設定されます。
restlet:protocol:host:port/uriPattern
パスおよびクエリーパラメーターを使用します。
281.2.1. パスパラメーター (4 パラメーター)
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| protocol | 必須 使用するプロトコル (http または https) | String | |
| host | 必須 restlet サービスのホスト名 | String | |
| port | 必須 restlet サービスのポート番号 | 80 | int |
| uriPattern | /customer/id などのリソースパターン | String |
281.2.2. クエリーパラメーター (18 パラメーター)
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| restletMethod (common) | プロデューサーエンドポイントで、使用するリクエストメソッドを指定します。コンシューマーエンドポイントで、エンドポイントが restletMethod リクエストのみを消費することを指定します。 | GET | メソッド |
| bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
| restletMethods (consumer) | コンマで区切られた 1 つ以上のメソッドを指定します (restletMethods=post,put など)。restlet コンシューマーエンドポイントによって処理されます。restletMethod と restletMethods の両方のオプションが指定されている場合、restletMethod の設定は無視されます。可能なメソッドは次のとおりです: ALL、CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT、TRACE | String | |
| disableStreamCache (consumer) | Restlet からの生の入力ストリームがキャッシュされるかどうかを決定します (Camel はストリームをメモリー内/ファイルへのオーバーフロー、ストリームキャッシュに読み込みます)。デフォルトでは、Camel は Restlet 入力ストリームをキャッシュして複数回の読み取りをサポートし、Camel がストリームからすべてのデータを取得できるようにします。ただし、ファイルやその他の永続ストアに直接ストリーミングするなど、生のストリームにアクセスする必要がある場合は、このオプションを true に設定できます。ストリームの複数回の読み取りをサポートするためにこのオプションが false の場合、DefaultRestletBinding は要求入力ストリームをストリームキャッシュにコピーし、それをメッセージ本文に入れます。 | false | boolean |
| exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、コンシューマーは例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
| exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
| restletUriPatterns (consumer) | 非推奨 Camel レジストリーのリストを参照する # 表記を使用して、restlet コンシューマーエンドポイントによってサービスされる 1 つ以上の URI テンプレートを指定します。URI パターンがエンドポイント URI で定義されている場合、エンドポイントで定義された URI パターンと restletUriPatterns オプションの両方が受け入れられます。 | List | |
| connectTimeout (producer) | 接続がタイムアウトの場合、クライアントは接続を断念します。無制限の待機の場合は 0 です。 | 30000 | int |
| cookieHandler (producer) | HTTP セッションを維持するようにクッキーハンドラーを設定します。 | CookieHandler | |
| socketTimeout (producer) | クライアントソケットの受信タイムアウト。無制限の待機の場合は 0。 | 30000 | int |
| throwExceptionOnFailure (producer) | プロデューサーの失敗時に例外を出力するかどうか。このオプションが false の場合、http ステータスコードは、エラー値があるかどうかを確認できるメッセージヘッダーとして設定されます。 | true | boolean |
| autoCloseStream (producer) | restlet プロデューサーを使用した REST サービスの呼び出しからの応答として、ストリーム表現を自動的に閉じるかどうか。応答がストリーミングで、オプション streamRepresentation が有効になっている場合は、ストリーミング応答から InputStream を自動的に閉じて、Camel Exchange のルーティングが完了したときに入力ストリームが閉じられるようにすることができます。ただし、Camel ルートの外でストリームを読み取る必要がある場合は、ストリームを自動的に閉じる必要がない場合があります。 | false | boolean |
| streamRepresentation (producer) | restlet プロデューサーを使用した REST サービスの呼び出しからの応答としてストリーム表現をサポートするかどうか。応答がストリーミングの場合、このオプションを有効にして、Camel Message 本文のメッセージ本文として java.io.InputStream を使用できます。このオプションを使用する場合、autoCloseStream オプションも有効にして、Camel Exchange のルーティングが完了したときに入力ストリームが確実に閉じられるようにすることができます。ただし、Camel ルートの外でストリームを読み取る必要がある場合は、ストリームを自動的に閉じる必要がない場合があります。 | false | boolean |
| headerFilterStrategy (advanced) | カスタムの HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルタリングします。 | HeaderFilterStrategy | |
| restletBinding (advanced) | カスタム RestletBinding を使用して、Restlet と Camel メッセージをバインドします。 | RestletBinding | |
| synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
| restletRealm (security) | restlet のセキュリティーレルムをマップとして設定します。 | Map | |
| sslContextParameters (security) | SSLContextParameters を使用してセキュリティーを設定する場合。 | SSLContextParameters |
