--- schema_version: "1" id: ad7aff8207c7e03ccf43c12c3e130a570e275460d2b5a060065c91fbff0bc87d title: WebSockets Connector リファレンス collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-reference.md canonical_url: https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: cb1fa81953651d1f1a62c865597cfd236be0ef7be118803d9786f70495d904b3 description: MuleSoft Documentation Site release: "1.0" latest: true --- # WebSockets Connector リファレンス サポートされるバージョン: [Select](https://www.mulesoft.com/legal/versioning-back-support-policy#anypoint-connectors) WebSockets Connector バージョン 1.0 WebSockets 用 Anypoint Connector (WebSockets Connector) は WebSockets プロトコルによる通信を提供して、外部システムがサーバーへの接続を開いたり (インバウンドソケット)、外部システムへの接続を確立したり (アウトバウンドソケット) できるようにします。どちらの場合も、全二重トラフィックがサポートされます。 リリースノート: [WebSockets Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/websockets-connector-release-notes-mule-4) ## [](#設定)設定 * * * ### [](#Config)デフォルト設定 デフォルト設定の名前および接続種別を設定します。 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Connection (接続)

この設定に指定する接続型。

x

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x
#### [](#接続種別)接続種別 ##### [](#Config_Connection)Connection (接続) 接続のサーバー、クライアント、および再接続パラメーターを設定します。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Server Settings (サーバー設定)

WebSocket Server Settings (WebSocket サーバー設定)

Client Settings (クライアント設定)

WebSocket Client Settings (WebSocket クライアント設定)

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。
## [](#操作)操作 WebSockets 用 Anypoint Connector (WebSockets Connector) は次の操作をサポートしています。 - [Broadcast (ブロードキャスト)](#Broadcast) - [Bulk Close Sockets](#BulkCloseSockets) - [Close Socket](#CloseSocket) - [Open Outbound Socket](#OpenOutboundSocket) - [Send (送信)](#Send) ### [](#関連付けられたソース)関連付けられたソース - [On New Inbound Message](#InboundListener) - [On New Inbound Connection](#OnInboundConnection) - [On Socket Closed](#OnSocketClosed) - [On New Outbound Message](#OutboundListener) ## [](#Broadcast)Broadcast (ブロードキャスト) `` パス、socketType、グループ条件に一致するすべてのアクティブな WebSockets にコンテンツを送信します。パスの場合、インバウンドとアウトバウンドソケットの両方を対象にできるため、設定済みのベースパスは考慮されません。 一部のソケットへの配信に失敗する可能性があったとしても、メッセージは一致するすべてのソケットに送信されます。この操作は、各失敗の詳細が含まれる ​`BroadcastFailure`​ のリストを返します。いずれも失敗しなかった場合は、空のリストが返されます。 ### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Content (コンテンツ)

Binary (バイナリ)

送信するコンテンツ。

#[payload]

Path (パス)

String (文字列)

一致するソケットのパス。

x

Socket Type (ソケット種別)

Enumeration (列挙)。次のいずれかになります。

  • INBOUND

  • OUTBOUND

  • ALL (すべて)

一致するソケットの種別。

ALL

Groups (グループ)

Array of String (文字列の配列)

これらのグループのいずれかに属すソケットに一致する。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力)出力

型

ブロードキャストの失敗​ の配列
### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#Config) ### [](#スロー)スロー - WEBSOCKET:CONNECTIVITY - WEBSOCKET:RETRY\_EXHAUSTED ## [](#BulkCloseSockets)Bulk Close Sockets `` ### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Socket Type (ソケット種別)

Enumeration (列挙)。次のいずれかになります。

  • INBOUND

  • OUTBOUND

  • ALL (すべて)

ALL (すべて)

Groups (グループ)

Array of String (文字列の配列)

Close Code (クローズコード)

Enumeration (列挙)。次のいずれかになります。

  • NORMAL_CLOSURE​

  • ENDPOINT_GOING_DOWN​

  • PROTOCOL_ERROR​

  • INVALID_DATA​

  • MESSAGE_TOO_LARGE

NORMAL_CLOSURE

理由

String (文字列)

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#Config) ### [](#スロー-2)スロー - WEBSOCKET:CONNECTIVITY - WEBSOCKET:RETRY\_EXHAUSTED ## [](#CloseSocket)Close Socket `` この操作でソケットが閉じられる。 ### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Socket Id

String (文字列)

閉じるソケットの ID。

x

Close Code (クローズコード)

Enumeration (列挙)。次のいずれかになります。

  • NORMAL_CLOSURE​

  • ENDPOINT_GOING_DOWN​

  • PROTOCOL_ERROR​

  • INVALID_DATA​

  • MESSAGE_TOO_LARGE

クローズコード。

NORMAL_CLOSURE

理由

String (文字列)

閉じる理由を示す語句。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#Config) ### [](#スロー-3)スロー - WEBSOCKET:CONNECTIVITY - WEBSOCKET:NO\_SUCH\_SOCKET - WEBSOCKET:RETRY\_EXHAUSTED ## [](#OpenOutboundSocket)Open Outbound Socket `` この操作で新しいアウトバウンドソケットが開かれる。 ### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Socket Id

String (文字列)

Default Groups (デフォルトグループ)

Array of String (文字列の配列)

ソケットが最初にサブスクライブするグループ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Path (パス)

String (文字列)

要求の送信先となるパス。

URL

String (文字列)

要求の送信先となる URL。

Headers (ヘッダー)

Object (オブジェクト)

メッセージに含まれる必要がある HTTP ヘッダー。

URI パラメーター

Object (オブジェクト)

要求の作成に使用する URI パラメーター。

クエリパラメーター

Object (オブジェクト)

要求に含まれる必要があるクエリパラメーター。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-2)出力

型

String (文字列)

Attributes Type (属性型)

WebSocket 属性
### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#Config) ### [](#スロー-4)スロー - WEBSOCKET:BASIC\_AUTHENTICATION - WEBSOCKET:CONNECTIVITY - WEBSOCKET:FORBIDDEN - WEBSOCKET:INTERNAL\_SERVER\_ERROR - WEBSOCKET:INVALID\_SOCKET\_ID - WEBSOCKET:NO\_SUCH\_SOCKET - WEBSOCKET:NON\_UNIQUE\_SOCKET\_ID - WEBSOCKET:NOT\_FOUND - WEBSOCKET:REMOTELY\_CLOSED - WEBSOCKET:RETRY\_EXHAUSTED - WEBSOCKET:SERVICE\_UNAVAILABLE - WEBSOCKET:UNAUTHORIZED ## [](#Send)Send (送信) `` 指定されたソケットを通じてコンテンツを送信する。 ### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Socket Id

String (文字列)

データの送信に使用するソケットの ID。

x

Content (コンテンツ)

Binary (バイナリ)

送信するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#Config) ### [](#スロー-5)スロー - WEBSOCKET:CONNECTIVITY - WEBSOCKET:NO\_SUCH\_SOCKET - WEBSOCKET:RETRY\_EXHAUSTED ## [](#ソース)ソース ## [](#InboundListener)On New Inbound Message `` 外部システムが WebSocket を通じて接続できるエンドポイントを公開します。このソースは、こうした WebSockets がこのサーバーに情報を送信するたびに所有フローをトリガーします。さらに、ソケット接続が確立されるとパスが一致する ​`websocket:on-inbound-connection`​ コンポーネントがトリガーされます。 ### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

設定で指定されたパスからの相対パス。

x

Default Groups (デフォルトグループ)

Array of String (文字列の配列)

新規作成されたソケットが最初にサブスクライブするグループ。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-3)出力

型

Any (任意)

Attributes Type (属性型)

インバウンド WebSocket 属性。
### [](#次の設定の場合-6)次の設定の場合 - [デフォルト設定](#Config) ## [](#OnInboundConnection)On New Inbound Connection `` インバウンド WebSocket 接続が確立されたときにトリガーされます。 ### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

設定で指定されたパスからの相対パス。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-4)出力

型

String (文字列)

Attributes Type (属性型)

WebSocket 属性
### [](#次の設定の場合-7)次の設定の場合 - [デフォルト設定](#Config) ## [](#OnSocketClosed)On Socket Closed `` WebSocket が閉じられたときにトリガーされる。 ### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

設定で指定されたパスからの相対パス。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-5)出力

型

終了された接続イベント。

Attributes Type (属性型)

WebSocket 属性
### [](#次の設定の場合-8)次の設定の場合 - [デフォルト設定](#Config) ## [](#OutboundListener)On New Outbound Message `` アウトバウンドソケットがメッセージを受信したときにトリガーされる。 ### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

設定で指定されたパスからの相対パス。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
### [](#出力-6)出力

型

Any (任意)

Attributes Type (属性型)

WebSocket 属性
### [](#次の設定の場合-9)次の設定の場合 - [デフォルト設定](#Config) ## [](#型)型 ### [](#WebSocketServerSettings)WebSocket Server Settings (WebSocket サーバー設定)
項目 型 説明 デフォルト値 必須

Listener Base Path (リスナーベースパス)

String (文字列)

この設定を通じて処理されるすべてのリソースに使用するベースパス。

/

リスナー設定

String (文字列)

インバウンドエンドポイントを公開するために使用される ​http:listener-config​ への参照。

x

Idle Socket Timeout (アイドルソケットタイムアウト)

Number (数値)

自動的に閉じるアイドル WebSockets のタイムアウト。

15

Idle Socket Timeout Unit (アイドルソケットタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

#idleSocketTimeout を評価する時間単位。

MINUTES
### [](#WebSocketClientSettings)WebSocket Client Settings (WebSocket クライアント設定)
項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

要求が送信されるホスト。

Port (ポート)

Number (数値)

要求が送信されるポート。プロトコル属性が WS (デフォルト) の場合、デフォルト値は ​80​ です。プロトコル属性が WSS の場合、デフォルト値は ​443​ です。

Base Path (ベースパス)

String (文字列)

この設定を参照するすべてのアウトバウンドソケットに使用するベースパス。

/

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • WS

  • WSS

アウトバウンド通信に使用するプロトコル。有効な値は ​WS​ と ​WSS​ です。デフォルト値は ​WS​ です。WSS を使用すると、HTTP 通信が TLS/SSL を使用して保護されます。WSS がプロトコルとして設定された場合、ユーザーは ​tls:context​ パラメーターを定義することで TLS/SSL 設定をカスタマイズできます。​tls:context​ が定義されていない場合、デフォルトの JVM 証明書が通信の確立に使用されます。

WS

Tls Context (TLS コンテキスト)

TLS

アウトバウンドソケットの WSS を有効にする TLS 設定要素への参照。

Default Headers (デフォルトヘッダー)

Header (ヘッダー)​ の配列

メッセージに含まれる必要があるデフォルト HTTP ヘッダー。

Default Query Params (デフォルトクエリパラメーター)

Query Param (クエリパラメーター)​ の配列

応答に含まれる必要があるデフォルトクエリパラメーター。

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

アイドル接続が終了されるタイムアウト。指定しない場合、タイムアウトはありません。

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

#connectionIdleTimeout を評価する時間単位。

MINUTES

Follow Redirects (リダイレクトをフォロー)

Boolean (ブール)

リダイレクトをフォローするかどうかを示します。

true

Preserve Headers Case (ヘッダーの文字を保持)

Boolean (ブール)

デフォルトでは、ヘッダーキーは内部的に小文字で保存されます。これは、ヘッダー処理のパフォーマンス向上が目的で、RFC の仕様どおりに正しく機能します。

サーバーが特定の文字のヘッダーを期待している場合、このフラグを ​`true`​ に設定してヘッダーキーの文字を保持します。

false

Max Connections (最大接続数)

Number (数値)

同時に開いた状態にできるアウトバウンド接続の最大数。デフォルトでは、接続数は無制限です。

-1

Proxy Config (プロキシ設定)

次のいずれかになります。

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。プロキシ要素では、必ずホスト名およびポート属性を定義し、必要に応じてユーザー名とパスワードを定義できます。

Authentication (認証)

HttpRequestAuthentication

HTTP 要求で使用する認証方式。
### [](#Tls)TLS
項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

トラストストア

Key Store (キーストア)

Key Store (キーストア)

Revocation Check (取り消し確認)
### [](#TrustStore)トラストストア
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ に設定した場合、証明書の検証が行われず、攻撃に対して脆弱な接続がレンダリングされます。各自の責任で使用してください。
### [](#KeyStore)Key Store (キーストア)
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーが含まれている場合は、この属性によって使用するキーの別名を示します。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。
### [](#StandardRevocationCheck)Standard Revocation Check (標準の取り消し確認)
項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に CRL を試みます (OCSP ではない)。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。
### [](#CustomOcspResponder)Custom Ocsp Responder (カスタム Ocsp レスポンダー)
項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。
### [](#CrlFile)CRL File (CRL ファイル)
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。
### [](#Header)Header (ヘッダー)
項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x
### [](#QueryParam)Query Param (クエリパラメーター)
項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x
### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#Reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。
### [](#ReconnectForever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。
### [](#InboundWebSocketAttributes)インバウンド WebSocket 属性。
項目 型 説明 デフォルト値 必須

バージョン

String (文字列)

要求の HTTP バージョン。

x

Local Address (ローカルアドレス)

String (文字列)

サーバーからのローカルホストアドレス。

x

Remote Address (リモートアドレス)

String (文字列)

送信者からのリモートホストアドレス。

x

Client Certificate (クライアント証明書)

Any (任意)

クライアント証明書 (双方向 TLS が有効な場合)。

Socket Id

String (文字列)

ソケット ID。

x

Socket Type (ソケット種別)

Enumeration (列挙)。次のいずれかになります。

  • INBOUND

  • OUTBOUND

ソケット種別。

x

Groups (グループ)

Array of String (文字列の配列)

このソケットがサブスクライブされるグループ。

x

Path (パス)

String (文字列)

要求が受信された場所のフルパス。

x

Request Uri (要求 URI)

String (文字列)

要求の完全 URI。

x

Schema (スキーマ)

Enumeration (列挙)。次のいずれかになります。

  • WS

  • WSS

要求の HTTP スキーム。

x

Query Params (クエリパラメーター)

Object (オブジェクト)

解析した文字列からビルドしたクエリパラメーターのマッピング。

x

Headers (ヘッダー)

Object (オブジェクト)

解析した文字列からビルドしたヘッダーのマッピング。

x

Uri Params (URI パラメーター)

Object (オブジェクト)

要求パスから抽出した URI パラメーター。

x

Method (メソッド)

String (文字列)

要求の HTTP メソッド。

x

Query String (クエリ文字列)

String (文字列)

要求のクエリ文字列。

x
### [](#RepeatableInMemoryStream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位
### [](#RepeatableFileStoreStream)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

プロセス失敗メッセージをトリガーするまでに、正常に処理されないメッセージを再配信できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。

SHA-256

Message Identifier (メッセージ識別子)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

メッセージを識別するために使用される戦略を定義します。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストア。
### [](#RedeliveryPolicyMessageIdentifier)Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)
項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。
### [](#WebSocketAttributes)WebSocket 属性
項目 型 説明 デフォルト値 必須

Socket Id

String (文字列)

ソケット ID。

x

Socket Type (ソケット種別)

Enumeration (列挙)。次のいずれかになります。

  • INBOUND

  • OUTBOUND

ソケット種別。

x

Groups (グループ)

Array of String (文字列の配列)

このソケットがサブスクライブされるグループ。

x

Path (パス)

String (文字列)

要求が受信された場所のフルパス。

x

Request Uri (要求 URI)

String (文字列)

要求の完全 URI。

x

Schema (スキーマ)

Enumeration (列挙)。次のいずれかになります。

  • WS

  • WSS

要求の HTTP スキーム。

x

Query Params (クエリパラメーター)

Object (オブジェクト)

解析した文字列からビルドしたクエリパラメーターのマッピング。

x

Headers (ヘッダー)

Object (オブジェクト)

解析した文字列からビルドしたヘッダーのマッピング。

x

Uri Params (URI パラメーター)

Object (オブジェクト)

要求パスから抽出した URI パラメーター。

x

Method (メソッド)

String (文字列)

要求の HTTP メソッド。

x

Query String (クエリ文字列)

String (文字列)

要求のクエリ文字列。

x
### [](#ClosedConnectionEvent)終了された接続イベント。
項目 型 説明 デフォルト値 必須

Code (コード)

Enumeration (列挙)。次のいずれかになります。

  • NORMAL_CLOSURE​

  • ENDPOINT_GOING_DOWN​

  • PROTOCOL_ERROR​

  • INVALID_DATA​

  • MESSAGE_TOO_LARGE

クローズコード。

x

理由

String (文字列)

ソケットが閉じられた理由が含まれる語句。
### [](#BroadcastFailure)ブロードキャストの失敗
項目 型 説明 デフォルト値 必須

エラーメッセージ

String (文字列)

例外

Any (任意)

Socket Id

String (文字列)

Type (型)

Enumeration (列挙)。次のいずれかになります。

  • INBOUND

  • OUTBOUND

Uri

String (文字列)
### [](#Proxy)Proxy (プロキシ)
項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシの使用対象にならないカンマ区切りホストのリスト。
### [](#NtlmProxy)NTLM Proxy (NTLM プロキシ)
項目 型 説明 デフォルト値 必須

Ntlm Domain (NTLM ドメイン)

String (文字列)

プロキシに対して認証するドメイン。

x

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシの使用対象にならないカンマ区切りホストのリスト。
## [](#関連情報)関連情報 - [WebSocket Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/) - [MuleSoft ヘルプセンター](https://help.mulesoft.com)