368.2. Websocket オプション
Jetty Websocket コンポーネントは、以下に示す 14 個のオプションをサポートしています。
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| staticResources (consumer) | 静的リソース (.html ファイルなど) のリソースパスを設定します。classpath: を接頭辞として付けた場合、リソースはクラスパスからロードできます。それ以外の場合、リソースはファイルシステムまたは JAR ファイルからロードされます。たとえば、ルートクラスパスからロードするには、classpath:. または classpath:WEB-INF/static を使用します。設定されていない場合 (null など)、静的リソースは使用されていません。 | String | |
| host (common) | ホスト名。デフォルト値は 0.0.0.0 です。 | 0.0.0.0 | String |
| port (common) | ポート番号。デフォルト値は 9292 です。 | 9292 | Integer |
| sslKeyPassword (security) | SSL を使用する場合のキーストアのパスワード。 | String | |
| sslPassword (security) | SSL 使用時のパスワード。 | String | |
| sslKeystore (security) | キーストアへのパス。 | String | |
| enableJmx (advanced) | このオプションが true の場合、Jetty JMX サポートがこのエンドポイントに対して有効になります。詳細は、Jetty JMX サポートを参照してください。 | false | boolean |
| minThreads (advanced) | サーバースレッドプール内のスレッドの最小数の値を設定します。MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.minThreads のデフォルト値は 1 です。 | Integer | |
| maxThreads (advanced) | サーバースレッドプールのスレッドの最大数の値を設定します。MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.maxThreads のデフォルト値は 1 2 noCores です。 | Integer | |
| threadPool (advanced) | サーバーのカスタムスレッドプールを使用する場合。MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. | ThreadPool | |
| sslContextParameters (security) | SSLContextParameters を使用してセキュリティーを設定します。 | SSLContextParameters | |
| useGlobalSslContext Parameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
| socketFactory (common) | サブプロトコル用のカスタム WebSocketFactory を含むマップを設定するには。マップのキーはサブプロトコルです。デフォルトのキーは、デフォルトの実装用に予約されています。 | Map | |
| resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
Jetty Websocket エンドポイントは、URI 構文を使用して設定されます。
websocket:host:port/resourceUri
パスおよびクエリーパラメーターを使用します。
368.2.1. パスパラメーター (3 パラメーター):
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| host | ホスト名。デフォルト値は 0.0.0.0 です。コンポーネントでこのオプションを設定すると、コンポーネントの設定値がデフォルトとして使用されます。 | 0.0.0.0 | String |
| port | ポート番号。デフォルト値は 9292 です。コンポーネントでこのオプションを設定すると、コンポーネントの設定値がデフォルトとして使用されます。 | 9292 | Integer |
| resourceUri | 必須 使用する Websocket チャネルの名前 | String |
368.2.2. クエリーパラメーター (18 パラメーター)
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| maxBinaryMessageSize (common) | websocketServlet によって作成された Websocket が閉じる前に受け入れることができるサイズをバイト単位で設定するために使用できます。(デフォルトは -1 または無制限) | -1 | Integer |
| bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
| sessionSupport (consumer) | 各 http 要求に対して HttpSession を有効にするセッションサポートを有効にするかどうか。 | false | boolean |
| staticResources (consumer) | 静的リソース (.html ファイルなど) のリソースパスを設定します。classpath: を接頭辞として付けた場合、リソースはクラスパスからロードできます。それ以外の場合、リソースはファイルシステムまたは JAR ファイルからロードされます。たとえば、ルートクラスパスからロードするには、classpath:. または classpath:WEB-INF/static を使用します。設定されていない場合 (null など)、静的リソースは使用されていません。 | String | |
| exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
| exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
| sendTimeout (producer) | Websocket チャネルに送信する際のミリ秒単位のタイムアウト。デフォルトのタイムアウトは 30000 (30 秒) です。 | 30000 | Integer |
| sendToAll (producer) | すべての websocket サブスクライバーに送信します。メッセージで WebsocketConstants.SEND_TO_ALL ヘッダーを使用する代わりに、エンドポイントレベルで設定するために使用できます。 | Boolean | |
| bufferSize (advanced) | 最大フレームバイトサイズでもある websocketServlet のバッファーサイズを設定します (デフォルトは 8192)。 | 8192 | Integer |
| maxIdleTime (advanced) | websocketServlet によって作成された Websocket がアイドル状態になってから閉じるまでの時間をミリ秒で設定します。(デフォルトは 300000) | 300000 | Integer |
| maxTextMessageSize (advanced) | websocketServlet によって作成された Websocket が閉じる前に受け入れることができるサイズを文字で設定するために使用できます。 | Integer | |
| minVersion (advanced) | websocketServlet で受け入れられる最小プロトコルバージョンを設定するために使用できます。(デフォルト 13 - RFC6455 バージョン) | 13 | Integer |
| synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
| allowedOrigins (cors) | CORS はオリジンを許可しました。すべてを許可するために使用します。 | String | |
| crossOriginFilterOn (cors) | CORS を有効にするかどうか | false | boolean |
| filterPath (cors) | CORS をフィルタリングするためのコンテキストパス | String | |
| enableJmx (monitoring) | このオプションが true の場合、Jetty JMX サポートがこのエンドポイントに対して有効になります。詳細は、Jetty JMX サポートを参照してください。 | false | boolean |
| sslContextParameters (security) | SSLContextParameters を使用してセキュリティーを設定します。 | SSLContextParameters |
