147.5. エンドポイントオプション

host (common)

必須: WebSocket ホスト名 (localhost や、クライアントモードの場合のリモートホストなど)。

String

port (common)

必須: 使用する WebSocket ポート番号。

int

path (common)

使用する WebSocket パス。

String

allowedOriginPattern (consumer)

WebSocket クライアントが送信した origin ヘッダーと一致する正規表現パターン。

String

allowOriginHeader (consumer)

WebSocket クライアントが、WebSocket ハンドシェイクリクエストに Origin ヘッダーを追加する必要があるかどうか。

true

boolean

consumeAsClient (consumer)

true に設定すると、consumer は WebSocket クライアントとして機能し、受信した WebSocket イベントごとに exchange を作成します。

false

boolean

fireWebSocketConnectionEvents (consumer)

新しい WebSocket ピアの接続時または接続切断時に、サーバー consumer がメッセージ exchange を作成するかどうか。

false

boolean

maxReconnectAttempts (consumer)

consumeAsClient が true に設定されている場合、以前に閉じられた WebSocket に対する再接続の試行が許可される最大回数が設定されます。値に 0 (デフォルト) を指定すると、無期限に再接続が試行されます。

0

int

originHeaderUrl (consumer)

WebSocket クライアントが WebSocket ハンドシェイクリクエストで使用する Origin ヘッダーの値。指定しない場合、WebSocket クライアントはリクエスト URL から Origin の値を自動的に決定します。

String

reconnectInitialDelay (consumer)

consumeAsClient が true に設定されている場合、以前に閉じられた WebSocket への再接続を試行するまでの初期遅延がミリ秒単位で設定されます。

0

int

reconnectInterval (consumer)

consumeAsClient が true に設定されている場合、以前に閉じられた WebSocket への再接続が行われる間隔をミリ秒単位で設定します。

1000

int

router (consumer)

HTTP サーバーに既存の vertx ルーターを使用します。

ルーター

serverOptions (consumer)

consumer 用の WebSocket をホストする HTTP サーバーを設定するためのカスタマイズされたオプションを設定します。

HttpServerOptions

bridgeErrorHandler (consumer (advanced))

コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

false

boolean

exceptionHandler (consumer (advanced))

consumer によるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

ExceptionHandler

exchangePattern (consumer (advanced))

consumer がエクスチェンジを作成する際に交換パターンを設定します。

列挙値:

ExchangePattern

clientOptions (producer)

producer で使用される WebSocket クライアントを設定するためのカスタマイズされたオプションを設定します。

HttpClientOptions

clientSubProtocols (producer)

クライアントが Sec-WebSocket-Protocol ヘッダーに使用する WebSocket サブプロトコルのコンマ区切りリスト。

String

sendToAll (producer)

すべての websocket サブスクライバーに送信します。メッセージで VertxWebsocketConstants.SEND_TO_ALL ヘッダーを提供する代わりに、エンドポイントレベルで設定するために使用できます。このオプションを使用する場合、vertx-websocket producer URI に指定されたホスト名は、既存の vertx-websocket consumer に使用されているホスト名と一致する必要があることに注意してください。このオプションは、vertx-websocket consumer によってホストされるエンドポイントにメッセージを生成する場合にのみ適用され、外部でホストされる WebSocket には適用されないことに注意してください。

false

boolean

lazyStartProducer (producer (advanced))

最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時に producer が失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、producer の作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。

false

boolean

sslContextParameters (security)

SSLContextParameters を使用してセキュリティーを設定する場合。

SSLContextParameters