# mulesoft Websockets Connector - Full Documentation

<!-- document id=f58af3c715d50d77488f3488ecf03f00eea6371aff051a0864ed44a4200dbd38 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-cloudhub.md -->

# CloudHub の WebSockets Connector

インバウンド WebSockets エンドポイント、アウトバウンド WebSockets エンドポイント、またはその両方が含まれる Mule アプリケーションを CloudHub にデプロイできます。

アプリケーションにインバウンド WebSockets エンドポイントのみが含まれる場合、アプリケーションを CloudHub にデプロイするには、次の手順を実行する必要があります。

1. Anypoint Virtual Private Cloud (VPC) を設定します。
2. 専用ロードバランサーをセットアップして、WS および WSS トラフィックを Mule アプリケーションを介してルーティングします。

インバウンド WebSocket エンドポイントをセットアップする手順は、次のとおりです。

1. 次のいずれかのポートでリスンするように WebSockets インバウンドリスナー (​`<ws:inbound-listener>`​) を設定します。
    
    - `0.0.0.0`​。
    - WS 経由で通信するには、リスナーポートを ​`8091`​ に設定します。
    - WSS 経由で通信するには、リスナーポートを ​`8092`​ に設定します。
2. VPC にアプリケーションをデプロイします。
3. 専用ロードバランサーの URL マッピングルールをセットアップして、URI を特定のアプリケーションに関連付けます。
    
    たとえば、アプリケーション名が「my-websockets-mule-app」である場合、次のようにルールを定義できます。
    
    - Input Path (入力パス): `/my-websockets-mule-app/`
    - Target App (対象アプリケーション): `my-websockets-mule-app`
    - Output Path (出力パス): `/`
    - Protocol (プロトコル): `ws`

このルールでは、実行されたすべての要求が専用ロードバランサーの URL に、指定した入力パスが Mule アプリケーションのルートパス ​`/`​ にルーティングされます。ロードバランサーの名前によって、割り当てられる URL が決まるため、この例では、ロードバランサーに ​`mylb`​ という名前を付けた場合、​`ws://mylb.lb.anypointdns.net:80/my-websockets-mule-app/`​ を参照して、WebSockets リスナーに接続する必要があります。

専用ロードバランサーは、ポート 80 に発行されたすべての要求をアプリケーションのポート 8091 (すべての WS 接続用のポート) に転送します。ただし、WSS を使用している場合、ポート 443 に要求を発行すると、これらの要求は Mule アプリケーションのポート 8092 に転送されます。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">CloudHub 2.0 デプロイメントでは、WebSockets をサポートする Mule アプリケーションが CloudHub 2.0 にデプロイされる他の Mule アプリケーションと同じ方法でデプロイされます。詳細は、<a href="https://docs.mulesoft.com/cloudhub-2/ch2-deploy" class="xref page">Deploying Apps to CloudHub 2.0</a>を参照してください。</td></tr></tbody></table>

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [VPC ネットワークアーキテクチャ](https://docs.mulesoft.com/cloudhub/vpc-architecture-concept)
- [専用ロードバランサーアーキテクチャ](https://docs.mulesoft.com/cloudhub/lb-architecture)
- [専用ロードバランサーのマッピングルール](https://docs.mulesoft.com/cloudhub/lb-mapping-rules)

<!-- document id=cd82494ea544aad560bd5d4c944f8208ba2b5163fbfad2fee4009f47645be777 url=/mulesoft/current/ja-jp/websockets-connector/latest/index.md -->

# WebSockets Connector

WebSockets Connector バージョン 1.0

WebSockets 用 Anypoint Connector (WebSockets Connector) には、次のインテグレーション機能があります。

- サーバーとクライアント間で双方向全二重通信を確立する
- サーバーのプッシュ通知を実装する
- 既存の HTTP インフラストラクチャ上でシームレスに機能する
- クライアントが定期的にサーバーの新しいデータをポーリングしないで済む

WebSocket は、クライアントとサーバー間の双方向 TCP 接続で、アプリケーションで接続を終了するまで開いたままになっています。WebSocket の場合、アプリケーションは HTTP を使用して初期接続を行います。その後、接続がソケットベースの TCP 接続にアップグレードされます。

リリースノート: [WebSockets Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/websockets-connector-release-notes-mule-4)​  
Exchange: [WebSockets Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-websockets-connector/)

## [](#全二重の利点)全二重の利点

従来の HTTP では、接続は半二重 (一方向) で、要求-応答メッセージエクスチェンジパターンを使用することで機能します。

1. クライアントはサーバーに接続して要求を送信します。
2. サーバーは要求を処理して応答を返します。クライアントが応答を受信すると接続が終了します。

従来の HTTP 接続では、クライアントアプリケーションがサーバーから応答を受信するまでブロックされるため、膨大なオーバーヘッドが必要になります。また、この接続種別では、クライアントが常に要求を開始する必要があります。そのため、サーバーは複数のアプリケーションに同時に通知をプッシュできません。

クライアントが WebSockets を使用してサーバーに接続すると、永続接続が確立され、開いたままになります。クライアントとサーバーの両方で複数のメッセージを相互に送信でき、HTTP 要求-応答メッセージエクスチェンジパターンに従う必要はありません。

WebSocket は、既存の HTTP インフラストラクチャ上に構築されるため、従来の HTTP のためにすでに用意されているインフラストラクチャを簡単に再利用できます。

[IETF ドキュメントの「RFC 6455 - the WebSocket protocol (RFC 6455 - WebSocket プロトコル)」](https://tools.ietf.org/html/rfc6455)​を参照してください。

## [](#websockets-connector-の一般的なユースケース)WebSockets Connector の一般的なユースケース

WebSockets Connector は、HTTP 要求-応答メッセージエクスチェンジパターンによって引き起こされるオーバーヘッドを回避する必要のあるリアルタイムアプリケーションで役立ちます。

WebSockets Connector の一般的なユースケースとして、チャットアプリケーションや株価情報アプリケーションなどが挙げられます。

### [](#チャットアプリケーション)チャットアプリケーション

チャットアプリケーションでは、サブスクライブしている参加者はクライアントがチャットグループにメッセージを送信した直後にそのメッセージを受信したいと考えています。アプリケーションが HTTP を使用する場合、クライアントは定期的にサーバーの使用可能なメッセージをポーリングする必要があるため、パフォーマンスが低下します。WebSockets を使用すると、サーバーは使用可能なメッセージをすべてのサブスクライブしているユーザーにプッシュできます。

### [](#株価情報アプリケーション)株価情報アプリケーション

クライアントは、一連の株式の更新価格を継続的に送信する株価情報サービスに対して WebSocket を開いておくことができます。このような価格は絶え間なく変化するため、同じ接続を再利用して不定期にメッセージを受信できる WebSockets は、この問題の最適なソリューションになります。この場合、クライアントは接続の確立後にサーバーにメッセージを送信しません。

## [](#互換性)互換性

WebSockets Connector は、以下と互換性があります。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">App/Service</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Version (バージョン)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Mule</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">4.2.2 以上</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Java</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8.0_x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Anypoint Studio</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">7.4 以上</p></td>
</tr>
</tbody>
</table>

## [](#始める前に)始める前に

アプリケーションを作成する前に、WebSockets の対象リソースおよび Anypoint Platform へのアクセス権を持っている必要があります。Anypoint Studio を使用して Mule アプリケーションを作成する方法を理解しておく必要があります。

## [](#websockets-の基本概念)WebSockets の基本概念

WebSockets Connector のしくみを理解するには、次の概念が不可欠です。

- [Socket Type (ソケット種別)](#socket_types)
- [Socket ID (ソケット ID)](#socket_id)
- [Groups (グループ)](#groups)
- [Triggers (トリガー)](#triggers)
- [操作](#operations)

### [](#socket_types)ソケット種別

WebSockets には次の 2 種類があります。

- Inbound (インバウンド)  
    Mule アプリケーションが受信接続をリスンするときに作成される WebSocket。
    
    このシナリオでは、外部システムが Mule アプリケーションによって公開されたエンドポイントに接続します。
- Outbound  
    Mule アプリケーションが外部システムに接続したときに作成される WebSocket。
    
    このシナリオでは、Mule アプリケーションが通信を開始し、WebSocket を確立するように外部システムに依頼します。

### [](#socket_id)ソケット ID

すべての WebSockets (インバウンドとアウトバウンドの両方) に、それらを識別する一意のソケット ID があります。アプリケーションは、それらの ID を参照して、個々の WebSockets を操作する必要があります。

### [](#groups)Groups (グループ)

WebSockets Connector には、グループ (個々の WebSockets が必要に応じてサブスクライブできる文字列識別子) の概念が導入されています。アプリケーションは、グループを使用して 1 つメッセージをさまざまな WebSockets のグループにブロードキャストできます。グループを使用すると、各ブロードキャストに参加すべき WebSockets を識別するためのプロセスが促進されます。

サブスクリプションは、WebSockets Connector 設定の各インスタンスのコンテキストにのみ存在します。そのため、Mule アプリケーションとリモートシステム間で WebSockets を確立した場合、グループに接続するための Mule 側の WebSockets にサブスクライブしても、リモートシステム側の WebSockets には影響しません。

## [](#triggers)トリガー

トリガーにより、メッセージやイベント通知の受信時にフローの実行が開始されます。WebSockets 関連のイベントで次のトリガーを指定できます。

- On New Inbound Message
    
    外部システムが接続でき、メッセージの受信時に含まれているフローを開始するエンドポイントを公開します。
- On New Inbound Connection
    
    インバウンドリスナーへの新しい接続が確立されたときにフローを開始します。
- On New Outbound Message
    
    アウトバウンド WebSockets が外部システムからメッセージを受信したときにフローを開始するエンドポイントを公開します。
- On Socket Closed
    
    インバウンドまたはアウトバウンド WebSockets の終了時に含まれているフローを開始します。

## [](#operations)操作

WebSockets 用 Anypoint Connector (WebSockets Connector) は次の操作をサポートしています。

- Open Outbound Socket
    
    外部システムに接続し、アウトバウンド webSocket を作成します。
- 送信
    
    WebSocket 経由でメッセージを送信します。
- Subscribe Groups
    
    1 つ以上のグループに WebSocket をサブスクライブします。アプリケーションは、同じ WebSocket でこの操作を複数回呼び出します。各呼び出しは前の呼び出しに追加されていきます。反復するグループは無視されます。
- Unsubscribe Groups
    
    1 つ以上のグループから WebSocket をサブスクライブ解除します。この操作は、同じソケットで複数回呼び出すことができます。各呼び出しは前の呼び出しに追加されていきます。反復するグループは無視されます。
- ブロードキャスト
    
    パス、種別、グループで分類された複数の WebSockets にメッセージを送信します。
- Close Socket
    
    WebSocket の接続を終了します。
- Bulk Close Socket
    
    複数の WebSocket の接続を終了します。

## [](#security)セキュリティ

WebSockets Connector では、TLS で次の URI スキームを使用してクライアントおよびサーバーエンドポイントを保護できます。

- WS は、暗号化を使用せずに WebSocket サーバーおよびリソース名を識別します (例: `ws://localhost:80`​)。
- WSS は、TLS で保護して WebSocket サーバーおよびリソース名を識別します (例: `wss://localhost:433`​)。

## [](#websockets-connector-と-runtime-fabric)WebSockets Connector と Runtime Fabric

WebSockets Connector を使用する Mule アプリケーションを開発して Mule を Runtime Fabric にデプロイする場合、Runtime Fabric で WebSockets Connector を有効にするために必要な追加の設定はありません。

## [](#関連情報)関連情報

- [WebSockets Connector の設定](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=d4ae41240bbdf134183a6f4402f08dbc8fd2025c9854394120e2f8e63cdfc25d url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-xml-maven.md -->

# WebSockets Connector の XML と Maven のサポート

XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。

Anypoint Studio の XML エディターまたはテキストエディターから Mule Runtime Engine (Mule) アプリケーションを手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションでコネクタにアクセスできます。

コネクタを Studio に追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力します。さらに、​`pom.xml`​ ファイルに連動関係を追加します。

## [](#コネクタの名前空間の追加)コネクタの名前空間の追加

次のコードを設定 XML のヘッダーの ​`<mule>`​ タグ内に貼り付けます。

```xml
http://www.mulesoft.org/schema/mule/websocket
http://www.mulesoft.org/schema/mule/websocket/current/mule-websocket.xsd
```

次の例は、​`<mule>`​ XML ブロック内に名前空間ステートメントが配置される方法を示しています。

```xml
<mule xmlns:websocket="http://www.mulesoft.org/schema/mule/websocket"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/websocket
	http://www.mulesoft.org/schema/mule/websocket/current/mule-websocket.xsd">
```

## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加

Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-websockets-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

`x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。

最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。

1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。
2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。
3. Exchange で、「​`websockets`​」を検索します。
4. コネクタを選択します。
5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。

## [](#次のステップ)次のステップ

名前空間および ​`pom.xml`​ ファイルを完了したら、​[例](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-examples)​を試すことができます。

## [](#関連情報)関連情報

- [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=3230939281c48a665d0196a479fd9a789dcaac9f7de70b76e5fb353bc94b6131 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-troubleshooting.md -->

# WebSockets Connector のトラブルシューティング

WebSockets 用 Anypoint Connector (WebSockets Connector) のトラブルシューティングを行うには、冗長ログの有効化と、スローされる一般的なメッセージの解釈に関する情報を理解しておきます。

## [](#冗長ログの有効化)冗長ログの有効化

アプリケーションと WebSockets Connector のやりとりが失敗する理由の理解を深めるには、コネクタの冗長ログを一時的に有効にします。  

Mule アプリケーションのパフォーマンスに影響するため、トラブルシューティングが完了したら、必ず拡張された冗長性を無効にしてください。

設定ファイルで冗長ログを有効にする手順は、次のとおりです。

1. Anypoint Studio にアクセスし、​**\[Package Explorer\]**​ ビューに移動します。
2. アプリケーションのプロジェクト名を開きます。
3. `src/main/resources`​ パスフォルダーを開きます。
4. フォルダー内の ​`log4j2.xml`​ ファイルを開きます。
5. `<Loggers>`​ タグ内に ​`<AsyncLogger>`​ タグを追加します。
    
    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="com.mulesoft.connectors.ws" level="DEBUG"/>
    				...
    			</Loggers>
    ```
6. アプリケーションの変更を保存します。
7. **Package Explorer**​ でプロジェクト名をクリックし、​**\[Run (実行)\]**​ > ​**\[Run As (別のユーザーとして実行)\]**​ > ​**\[Mule Application (Mule アプリケーション)\]**​ をクリックします。

## [](#一般的なスローを理解する)一般的なスローを理解する

ここでは、一般的なスローメッセージとその解決方法を示します。

- WEBSOCKET:CONNECTIVITY
    
    接続が有効ではなくなりました。アプリケーションの設定で定義されている場合、再接続ポリシーを適用してください。
- WEBSOCKET:RETRY\_EXHAUSTED
    
    操作の最大再試行回数に達しました。
- WEBSOCKET:NO\_SUCH\_SOCKET
    
    The WebSocket cannot be referenced because the WebSocket ID does not exist. (WebSocket ID が存在しないため、WebSocket を参照できません。)
- WEBSOCKET:BASIC\_AUTHENTICATION
    
    The HTTP ​\*Request\*​ operation lacks basic authentication to send requests to the service, or the provided credentials are incorrect. (HTTP の Request 操作でサービスに要求を送信するための基本認証がないか、指定されたログイン情報が正しくありません。)
- WEBSOCKET:FORBIDDEN
    
    クライアントにコンテンツへのアクセス権がないため、サーバーが要求されたリソースの提供を拒否しています。
- WEBSOCKET:INTERNAL\_SERVER\_ERROR
    
    The server encountered a problem that prevented it from fulfilling the request. (サーバーで要求を満たせない問題が発生しました。)
- WEBSOCKET:INVALID\_SOCKET\_ID
    
    The WebSocket ID is null or blank. (WebSocket ID が null か空白です。)
- WEBSOCKET:NON\_UNIQUE\_SOCKET\_ID
    
    An error occurred while registering the WebSocket because the ID already exists. (ID がすでに存在するため、WebSocket の登録中にエラーが発生しました。)
- WEBSOCKET:NOT\_FOUND
    
    The server could not find the requested resource. (サーバーは要求されたリソースを見つけることができませんでした。)
- WEBSOCKET:REMOTELY\_CLOSED
    
    The remote host closed the connection, which could be related to an SSL/TLS handshake issue. (リモートホストによって接続が閉じられました。SSL/TLS ハンドシェイクの問題に関連する可能性があります。)Check protocols, cipher suites, and certificate setup. (プロトコル、暗号化スイート、証明書セットアップを確認してください。)Use -Djavax.net.debug=ssl for further debugging. (さらにデバッグするには、-Djavax.net.debug=ssl を使用してください。)
- WEBSOCKET:SERVICE\_UNAVAILABLE
    
    サーバーはメンテナンスまたは過負荷のためにダウンしているため、要求を管理できません。
- WEBSOCKET:UNAUTHORIZED
    
    The authentication failed or has not yet been provided to get the requested response. (要求された応答を取得するための認証に失敗したか、認証がまだ提供されていません。)

## [](#関連情報)関連情報

- [WebSockets Connector リファレンス](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-reference)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=ed0397bfde67eb8377c4353e8fe9bf10ddf7ad294036fe55654ab8361af78289 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-examples.md -->

# WebSockets Connector の例

次の Mule アプリケーションの例では、WebSockets 用 Anypoint Connector (WebSockets Connector) を使用して、株価情報を取得してブロードキャストするインテグレーションシステムを構築できます。

## [](#quote-producer-app)Quote Producer App

次の Mule アプリケーションは、継続的でランダムな株価情報を生成します。

![Anypoint Studio キャンバスの Quote Producer App フロー](/mulesoft/current/ja-jp/websockets-connector/latest/_images/websocket-example-1.png)

1. 株価情報の例:

{
   "ticker": "CRM",
   "price": 157.6,
   "cur": "USD",
  "timestamp": 1563374475104
}

- `Quote`​ 種別で前述の株価情報の例を識別します。
- Mule アプリケーションは、少なくとも 5 つの異なるティッカー (CRM、MELI、GOOG、NFLX、AAPL) を使用するランダムな株価を使用して約 50 件の見積を生成します。
- また、1 つの接続のみを受け入れる TLS セキュア ​`wss://localhost:60000/feed`​ エンドポイントを公開します。
- 最初のクライアントはエンドポイントに正常に接続する必要があります。
- エンドポイントに接続する以降のクライアントには、「​`"Sorry, spot taken"`​ (申し訳ありません。スポットは取得済みです)」というテキストが含まれる WSS メッセージが送信されます。
- 生成された各見積もりが接続されたフィードクライアントに送信されます。

対応するキーストアを生成する手順は、次のとおりです。

1. ターミナルを開きます。
2. ターミナルで、Studio のプロジェクトアプリケーションの ​`src/main/resources`​ フォルダーに移動します。
3. 次のコマンドを実行します。
    
    `keytool -genkey -v -keystore producer-keystore.jks -alias producerkey -keyalg RSA -keysize 2048 -validity 10000`

## [](#quote-producer-app-の-xml)Quote Producer App の XML

この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:tls="http://www.mulesoft.org/schema/mule/tls"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:websocket="http://www.mulesoft.org/schema/mule/websocket" xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:os="http://www.mulesoft.org/schema/mule/os" xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/websocket http://www.mulesoft.org/schema/mule/websocket/current/mule-websocket.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.xsd">


<tls:context name="TLS_Context">
        <tls:key-store
		path="producer-keystore.jks"
		alias="producerkey"
		keyPassword="mule123"
		password="mule123" />
    </tls:context>

    <http:listener-config name="HTTP_TLS_Listener_config">
        <http:listener-connection
		host="0.0.0.0"
		port="60000"
		tlsContext="TLS_Context"
		protocol="HTTPS"/>
    </http:listener-config>

    <http:listener-config name="HTTP_Listener_config">
        <http:listener-connection host="0.0.0.0" port="60001" />
    </http:listener-config>

    <websocket:config name="WebSockets_Config">
        <websocket:connection >
            <websocket:server-settings listenerConfig="HTTP_TLS_Listener_config" />
        </websocket:connection>
    </websocket:config>

    <os:object-store name="Object_store" persistent="false" />

 	<flow name="stock-quotes-producer-flow">
        <scheduler>
            <scheduling-strategy >
                <fixed-frequency frequency="15" timeUnit="SECONDS"/>
            </scheduling-strategy>
        </scheduler>

        <ee:transform doc:name="Transform Message">
            <ee:message >
                <ee:set-payload >
                    <![CDATA[%dw 2.0
                    var randomStockSelector = randomInt(5)
                    var randomPriceVariation = (randomInt(401) / 100) - 2 as String { format: "#.00"} as Number
                    var baseStockQuotes = [
                        {
                            "ticker": "CRM",
                            "price": 157.6,
                            "cur": "USD"
                        },
                        {
                            "ticker": "MELI",
                            "price": 646.24,
                            "cur": "USD"
                        },
                        {
                            "ticker": "GOOG",
                            "price": 1134.14,
                            "cur": "USD"
                        },
                        {
                            "ticker": "NFLX",
                            "price": 316.53,
                            "cur": "USD"
                        },
                        {
                            "ticker": "AAPL",
                            "price": 208.19,
                            "cur": "USD"
                        }
                    ]
                    var selectedStock = baseStockQuotes[randomStockSelector]
                    output application/json
                    ---
                    {
                        ticker : selectedStock.ticker,
                        price : selectedStock.price + randomPriceVariation,
                        cur : selectedStock.cur,
                        timestamp : now() as Number
                    }]]>
                </ee:set-payload>
            </ee:message>
        </ee:transform>
        <flow-ref name="send-stock-quote-flow"/>
    </flow>

    <flow name="send-stock-quote-flow">
		<os:contains
		objectStore="Object_store"
		key="webSocketConnectedId"
		target="webSocketConnected"/>
        <choice>
            <when expression="#[vars.webSocketConnected]">
                <logger level="INFO" message="Sending" />
				<os:retrieve
			objectStore="Object_store"
			target="webSocketConnectedId"
			key="webSocketConnectedId" />
				<websocket:send
			socketId="#[vars.webSocketConnectedId]"
			config-ref="WebSockets_Config"/>
            </when>
        </choice>
    </flow>

	<flow name="on-new-inbound-connection-flow">
		<websocket:on-inbound-connection
			doc:name="On New Inbound Connection"
			config-ref="WebSockets_Config"
			path="/feed" />
		<os:contains
			key="webSocketConnectedId"
			target="webSocketConnected"
			objectStore="Object_store"/>
		<choice>
			<when expression="#[vars.webSocketConnected]">
				<os:retrieve
					key="webSocketConnectedId"
					objectStore="Object_store"
					target="webSocketConnectedId" />
				<websocket:close-socket
					socketId="#[attributes.socketId]"
					reason="Sorry, spot taken"
					config-ref="WebSockets_Config"/>
			</when>
			<otherwise>
				<os:store key="webSocketConnectedId" objectStore="Object_store">
					<os:value ><![CDATA[#[attributes.socketId]]]></os:value>
				</os:store>
			</otherwise>
		</choice>
	</flow>

	<flow name="on-new-inbound-message-flow">
		<websocket:inbound-listener config-ref="WebSockets_Config" path="/feed"/>
		<logger
			level="INFO"
			doc:name="Logger"
			message="#[output application/json
		---
		{
			info: 'New message received from [' ++ attributes.socketId ++ ']',
			payload : payload
		}]"/>
	</flow>

	<flow name="on-socket-closed-flow">
		<websocket:on-socket-closed config-ref="WebSockets_Config" path="/feed"/>
		<os:retrieve
			key="webSocketConnectedId"
			objectStore="Object_store"
			target="webSocketConnectedId" />
		<choice>
			<when expression="#[attributes.socketId == vars.webSocketConnectedId]">
				<os:remove key="webSocketConnectedId" objectStore="Object_store"/>
			</when>
		</choice>
	</flow>

	<flow name="close-websocket-flow">
		<os:contains
			key="webSocketConnectedId"
			target="webSocketConnected"
			objectStore="Object_store"/>
		<choice>
			<when expression="#[vars.webSocketConnected]">
				<os:retrieve
					doc:name="Retrieve"
					key="webSocketConnectedId"
					objectStore="Object_store"
					target="webSocketConnectedId" />
				<websocket:close-socket
					config-ref="WebSockets_Config"
					socketId="#[vars.webSocketConnectedId]"
					reason="Producer app wanted to close the websocket"/>
			</when>
		</choice>
	</flow>

</mule>
```

## [](#quote-aggregator-app)Quote Aggregator App

次の Mule アプリケーションは、前の Quote Producer App のフィードエンドポイントに接続し、すべての見積を受信します。次の、Quote Producer App はティッカー別に見積を分割し、5 秒ごとに実行される時間ベースのアグリゲーターに配置します。

![Anypoint Studio キャンバスの Quote Aggregator App フロー](/mulesoft/current/ja-jp/websockets-connector/latest/_images/websocket-example-2.png)

集計が実行されると、アグリゲーターは縮小される ​`Array<Quote>`​ を単一の ​`QuoteSnapshot`​ 種別に出力します。

QuoteSnapshot 種別の例

```json
{
   "ticker": "CRM"
   "price": "157.54 USD"
}
```

- 縮小は、タイムスタンプが最大の ​`Quote`​ を選択して変換することで実行されます。
- 生成されたスナップショットはサブスクライバーの動的リストにブロードキャストされます。
- サブスクリプションは、Quote Aggregator App が公開する ​`wss://localhost:8082/quotes`​ エンドポイントを通じて実行されます。
- クライアントはどの株価情報に従うかを示すクエリパラメーターを使用して前のエンドポイントに接続できます (例: `wss://localhost:8082/quotes?ticker=CRM&ticker=MELI`​)。

対応するキーストアとトラストストアを生成する手順は、次のとおりです。

1. ターミナルを開きます。
2. ターミナルで、Studio のプロジェクトアプリケーションの ​`src/main/resources`​ フォルダーに移動します。
3. キーストアの次のコマンドを実行します。
    
    `keytool -genkey -v -keystore broadcast-keystore.jks -alias broadcast -keyalg RSA -keysize 2048 -validity 10000`
4. 次のコマンドを実行してトラストストアを生成します。
    
    `keytool -genkey -v -keystore aggregator-truststore.jks -alias broadcast -keyalg RSA -keysize 2048 -validity 10000`

要求によって、​`CRM`​ および ​`MELI`​ ティッカーのスナップショットを取得する WebSocket が確立されます。これは、生成されたソケットを適切なソケットグループにサブスクライブすることで実行されます。

Quote Aggregator App を Quote Producer App に接続するには、次のコマンドを使用して、アウトバウンドソケットを開くフローをトリガーします。

\+ `curl -k [http://localhost:8081/connect](http://localhost:8081/connect)`

## [](#quote-aggregator-app-の-xml)Quote Aggregator App の XML

この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:tls="http://www.mulesoft.org/schema/mule/tls"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:websocket="http://www.mulesoft.org/schema/mule/websocket"
	xmlns:os="http://www.mulesoft.org/schema/mule/os"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.xsd
http://www.mulesoft.org/schema/mule/websocket http://www.mulesoft.org/schema/mule/websocket/current/mule-websocket.xsd">


	<tls:context name="TLS_Context">
        <tls:trust-store path="aggregator-truststore.jks" password="mule123" insecure="true"/>
    </tls:context>

    <http:listener-config name="HTTP_API_Listener_config">
        <http:listener-connection host="0.0.0.0" port="61000" />
    </http:listener-config>

    <websocket:config name="WebSockets_Client_Config">
        <websocket:connection >
            <websocket:client-settings
	    	host="0.0.0.0"
		port="60000"
		protocol="WSS"
		tlsContext="TLS_Context"/>
        </websocket:connection>
    </websocket:config>

    <os:object-store name="Object_store" persistent="false" />

	<tls:context name="TLS_Context_Broadcast">
        <tls:key-store
		path="broadcast-keystore.jks"
		alias="broadcast"
		keyPassword="mule123"
		password="mule123" />
    </tls:context>

    <http:listener-config name="HTTP_WebSockets_Listener_Config">
        <http:listener-connection
		host="0.0.0.0"
		port="61001"
		tlsContext="TLS_Context_Broadcast"
		protocol="HTTPS"/>
    </http:listener-config>

    <websocket:config name="WebSockets_Server_Config">
        <websocket:connection >
            <websocket:server-settings listenerConfig="HTTP_WebSockets_Listener_Config" />
        </websocket:connection>
    </websocket:config>


    <http:listener-config name="HTTP_Listener_config"  >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="broadcasting-stock-quote-snapshot">
		<logger level="INFO" doc:name="Logger" message="#[output application/json
            ---
            {
                info: 'Broadcasting stock quote reduction',
                payload: payload
            }]"/>
    </flow>
	<flow name="producer-app-websocket-open-flow">
        <http:listener  config-ref="HTTP_Listener_config" path="/connect"/>
		<websocket:open-outbound-socket config-ref="WebSockets_Client_Config" path="/feed"/>
        <logger
		level="INFO"
		message="#['New connection established with [' ++ attributes.socketId ++ ']']" />
        <os:contains key="socketId" objectStore="Object_store" target="webSocketConnected" />
        <choice>
            <when expression="#[vars.webSocketConnected]">
                <logger
			level="INFO"
			message="#['The websocket [' ++ attributes.socketId ++ '] is not saved as there is already one connected']"/>
            </when>
            <otherwise >
                <logger
			level="INFO"
			message="#['Websocket with ID [' ++ attributes.socketId ++ '] is saved for later reference']"/>
                <os:store key="socketId" objectStore="Object_store">
                    <os:value><![CDATA[#[attributes.socketId]]]></os:value>
                </os:store>
            </otherwise>
        </choice>
    </flow>

    <flow name="webs-quote-aggFlow"  >
		<websocket:on-inbound-connection  config-ref="WebSockets_Server_Config" path="/quotes"/>
		<websocket:subscribe-groups config-ref="WebSockets_Server_Config" socketId="#[attributes.socketId]" groups='#[[attributes.headers.groups]]' />
	</flow>
	<flow name="client-app-websocket-inbound-listener-flow">
        <websocket:inbound-listener doc:name="On New Inbound Message" config-ref="WebSockets_Server_Config" path="/quotes" />
        <logger level="INFO" doc:name="Logger" message="#[output application/json
            ---
            {
                info: 'New message received from [' ++ attributes.socketId ++ ']',
                payload: payload
            }]" />
    </flow>
	<flow name="producer-app-websocket-outbound-listener-flow">
        <websocket:outbound-listener
		config-ref="WebSockets_Client_Config"
		path="/feed"
		outputMimeType="application/json"/>
        <logger level="INFO" message="#[output application/json
            ---
            {
                info: 'New message received from [' ++ attributes.socketId ++ ']',
                payload: payload
            }]" />
		<logger level="INFO" message="#[[payload.ticker]]"/>
		<websocket:broadcast config-ref="WebSockets_Server_Config" path="/quotes" groups="#[[payload.ticker]]"/>
    </flow>

    <flow name="producer-app-websocket-close-flow">
        <os:contains key="socketId" objectStore="Object_store" target="webSocketConnected"/>
        <choice>
            <when expression="#[vars.webSocketConnected]">
                <os:retrieve key="socketId" objectStore="Object_store" target="socketId"/>
                <logger
			level="INFO"
			message="#['Trying to close websocket [' ++ vars.socketId as String ++ ']']"/>
                <websocket:close-socket
			config-ref="WebSockets_Client_Config"
			socketId="#[vars.socketId]"
			reason="Client wants to close the websocket"/>
            </when>
            <otherwise >
                <logger level="INFO" message="There is no WebSocket to close"/>
            </otherwise>
        </choice>
    </flow>

    <flow name="producer-app-websocket-on-socket-closed-flow">
        <websocket:on-socket-closed config-ref="WebSockets_Client_Config" path="/feed"/>
        <logger
		level="INFO"
		message="#['Websocket [' ++ attributes.socketId ++ '] was closed']"/>
        <os:retrieve key="socketId" objectStore="Object_store" target="socketId" />
        <choice>
            <when expression="#[attributes.socketId == vars.socketId]">
                <logger
			level="INFO"
			message="#['Removing the websocket ID stored for referencing it']" />
                <os:remove key="socketId" objectStore="Object_store" />
            </when>
            <otherwise >
                <logger
			level="INFO"
			message="#['Disconnected WebSocket is not the main one [' ++ vars.socketId as String ++ ']']" />
            </otherwise>
        </choice>
    </flow>

    </mule>
```

## [](#quote-client-app)Quote Client App

次の Mule アプリケーションによって少なくとも 3 つの異なる WebSockets が Quote Aggregator App の見積エンドポイントに開かれます。こうした各ソケットは異なるセットのティッカーをリスンします。

![Anypoint Studio キャンバスの Quote Client App フロー](/mulesoft/current/ja-jp/websockets-connector/latest/_images/websocket-example-3.png)

Figure 1. Quote Client App フロー

受信された ​`QuoteSnapshots`​ は CSV 形式に変換され、ファイルに付加されます。

対応するキーストアを生成する手順は、次のとおりです。

1. ターミナルを開きます。
2. ターミナルで、Studio のプロジェクトアプリケーションの ​`src/main/resources`​ フォルダーに移動します。
3. 次のコマンドを実行します。
    
    `keytool -genkey -v -keystore client-truststore.jks -alias client -keyalg RSA -keysize 2048 -validity 10000`

Quote Client App を Quote Aggregator App に接続するには、次のコマンドを使用して、アウトバウンドソケットを開くフローをトリガーします。

`curl -k [http://localhost:62000/open-aggregator-ws\?ticker\=CRM](http://localhost:62000/open-aggregator-ws\?ticker\=CRM)`

## [](#quote-client-app-の-xml)Quote Client App の XML

この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:tls="http://www.mulesoft.org/schema/mule/tls"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.mulesoft.org/schema/mule/websocket"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/websocket http://www.mulesoft.org/schema/mule/websocket/current/mule-websocket.xsd">

    <http:listener-config name="HTTP_Listener_config">
      <http:listener-connection host="0.0.0.0" port="62000" />
  </http:listener-config>

  <websocket:config name="WebSockets_Client_App_Config">
      <websocket:connection>
          <websocket:client-settings host="0.0.0.0" port="61001" protocol="WSS">
              <tls:context >
                  <tls:trust-store path="client-truststore.jks" password="mule123" insecure="true"/>
              </tls:context>
          </websocket:client-settings>
      </websocket:connection>
  </websocket:config>

  <flow name="aggregator-app-websocket-open-flow">
      <http:listener doc:name="Listener"
  config-ref="HTTP_Listener_config"
  path="open-aggregator-ws"/>
      <set-variable value="#[attributes.queryParams.*ticker]" variableName="groups"/>
      <logger level="INFO" message="#[vars.groups]"/>
  <websocket:open-outbound-socket config-ref="WebSockets_Client_App_Config" path="/quotes" socketId="#[attributes.socketId]" defaultGroups="#[vars.groups]">
    <websocket:headers ><![CDATA[#[output application/java
---
{
groups : vars.groups[0]
}]]]></websocket:headers>
  </websocket:open-outbound-socket>
  </flow>

  <flow name="stock-quotes-clientFlow">
      <websocket:outbound-listener
  config-ref="WebSockets_Client_App_Config"
  path="/quotes"
  outputMimeType="application/json"/>
      <logger level="INFO" doc:name="Logger" message="#[output application/json
          ---
          {
              info: 'New message received on [' ++ attributes.socketId ++ ']',
              payload: payload
          }]"/>
  </flow>
<flow name="webs-clientFlow" >
  <websocket:subscribe-groups config-ref="WebSockets_Client_App_Config" socketId="#[attributes.socketId]" groups="#[vars.groups]" />
</flow>

</mule>
```

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSocket Connector の設定](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)
- [WebSocket Connector サーバーコンポーネント](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-server-components)
- [WebSocket Connector メッセージング操作](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-messaging-operations)

<!-- document id=f2d2b77de407b5539e37e0bdf92509ca6e912c7503293ec0793dd0a19f39e19a url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-config-topics.md -->

# WebSockets Connector の設定

アプリケーションで WebSockets インバウンドエンドポイントを公開する場合、​`<ws:server-settings>`​ 要素を使用してそれをセットアップする必要があります。

WebSockets 接続は HTTP 要求で開始されるため、WebSockets インバウンドエンドポイントを公開するには、基盤となる HTTP リスナー設定を参照する必要があります。これにより、HTTP リスナーの使用可能なすべての機能および設定 (ホスト、ポート、TLS など) を再利用できるようになるだけでなく、アプリケーションで同じポートを使用して WebSockets エンドポイントと通常の HTTP エンドポイントの両方を公開できるようになります。

HTTP リスナー設定を使用して、ホスト、ポート、ベースパスなどのベース接続設定を指定したり、TLS ベースの接続 (WSS) を設定したりできます。

```xml
<http:listener-config name="httpListenerConfig" basePath="/regularHttp">
   <http:listener-connection host="0.0.0.0" port="80" />
</http:listener-config>

<websocket:config name="wsServer">
    <websocket:connection>
       <websocket:server-settings listenerConfig="httpListenerConfig" listenerBasePath="/ws"/>
    </websocket:connection>
</websocket:config>

<flow name="chat">
    <websocket:inbound-listener path="/chat" config-ref="wsServer"/>
    <logger level="INFO" message="A new message has been received! #[payload]"/>
</flow>
```

WebSockets サーバー設定では、​`listenerConfig`​ 属性の HTTP リスナー設定を参照します。この例では、WebSockets インバウンドリスナーは、HTTP リスナー設定で設定された ​`localhost`​ およびポート 80 で受信メッセージをリスンします。また、basePath を ​`/ws`​ に設定して、WebSockets 設定の HTTP basePath 設定を上書きします。要約すると、WebSockets インバウンドリスナーは、​`ws://localhost:80/ws/chat`​ で受信メッセージをリスンします。

HTTP リスナーには、TLS 設定コンポーネントへの参照がないため、デフォルトでは WS プロトコルを使用して接続が開きます。

## [](#サーバータイムアウトの設定)サーバータイムアウトの設定

WebSockets 接続は、永続的でステートフルです。そのため、アイドル状態の接続が自動的に終了するようにタイムアウトを設定することをお勧めします。

次の例は、​`<websocket:server-settings>`​ を使用して 1 時間のアイドルソケットタイムアウトを設定する方法を示しています。

```xml
<http:listener-config name="httpListenerConfig" basePath="/regularHttp">
   <http:listener-connection host="0.0.0.0" port="80" />
</http:listener-config>

<websocket:config name="wsServer">
    <websocket:connection>
       <websocket:server-settings
         listenerConfig="httpListenerConfig"
         listenerBasePath="/ws"
         idleSocketTimeout="1"
         idleSocketTimeoutUnit="HOURS">
    </websocket:connection>
</websocket:config>
```

デフォルトでは、すべてのインバウンドソケットに 15 分のアイドルタイムアウトが設定されています。

## [](#websockets-クライアントの設定)WebSockets クライアントの設定

アプリケーションが外部 WebSockets サービスに接続する必要がある場合、クライアント設定要素を指定します。

```xml
<websocket:config name="wsClient">
    <websocket:connection>
       <websocket:client-settings
         host="localhost"
         port="80"
         basePath="/ws" />
    </websocket:connection>
</websocket:config>

<flow="connectToWebSocketFlow">
    <websocket:open-outbound-socket
      path="/chat"
      socketId="myCustomWebSocketID-123"
      config-ref="wsClient" />
    </websocket:open-outbound-socket>

    <logger info="INFO" message="Opened connection to external service!"/>
</flow>
```

この例では、config-ref 属性の WebSockets クライアント設定 (wsClient) を参照するアウトバウンドソケットを初期化しています。この場合、HTTP 設定を参照する必要はありません。

上記の設定では、WS 要求 URI を構築するために ​`host`​、​`port`​、​`basePath`​ が指定されています。​`host`​ パラメーターは省略可能です。設定しない場合は、​`localhost`​ に設定されます。

`port`​ パラメーターは省略可能です。指定しない場合は、プロトコルスキームに従ってデフォルト値が設定されます。WS が使用される場合、デフォルト値は ​`80`​ に設定されます。WSS が使用される場合、デフォルト値は ​`443`​ に設定されます。

`basePath`​ パラメーターは省略可能です。URI が設定されていない場合は、指定したホストおよびポートに相対的なすべてのクライアント要求のベースパスを示します。​`basePath`​ パラメーターが設定されていない場合、デフォルト値は ​`/`​ に設定されます。

また、URL を指定することもできます。

```xml
<websocket:config name="wsClient">
    <websocket:connection>
       <websocket:client-settings uri="ws://www.mulesoft.com" />
    </websocket:connection>
</websocket:config>
```

ただし、その場合、​`URL`​ パラメーターと ​`path`​ パラメーターは相互に排他的であるため、パスを指定することはできません。これは、パスがホスト、ポート、ベースパスに相対的なパスを示すのに対して、URL はフルリソースロケーターを示すためです。

## [](#デフォルトパラメーターおよびヘッダー)デフォルトパラメーターおよびヘッダー

クライアント設定で、接続要求メッセージに含めるデフォルトヘッダーとデフォルトクエリパラメーターを指定できます。

```xml
<websocket:config name="wsClient">
    <websocket:connection>
       <websocket:client-settings host="localhost" port="${listenerPort}" basePath="/ws">
           <websocket:default-headers>
                <websocket:header key="myFirstDefaultHeader" value="defaultHeader1" />
                <websocket:header key="mySecondDefaultHeader" value="defaultHeader2" />
            </websocket:default-headers>
            <websocket:default-query-params>
                <websocket:query-param key="myFirstDefaultQueryParam" value="query1" />
                <websocket:query-param key="mySecondDefaultQueryParam" value="query2" />
            </websocket:default-query-params>
       </websocket:client-settings>
    </websocket:connection>
</websocket:config>
```

ヘッダーまたはクエリパラメーターを connect 操作に追加することもできます。これらは、接続を確立するために要求のデフォルトヘッダーおよびパラメーターと共に送信されます。

```xml
<flow="connectToWebSocketFlow">
    <websocket:open-outbound-socket path="/chat" config-ref="wsClient">
            <websocket:headers><![CDATA[
                    #[
                        {
                            chatAlias: 'Captain Marvel'
                        }
                    ]
                ]]>
            </websocket:headers>
            <websocket:query-params><![CDATA[
                    #[
                        {
                            theme: 'USA'
                        }
                    ]
                ]]>
            </websocket:query-params>
    </websocket:open-outbound-socket>
</flow>
```

## [](#クライアントタイムアウトの設定)クライアントタイムアウトの設定

インバウンド接続と同様に、アイドル状態のアウトバウンド接続が自動的に終了するようにタイムアウトを設定することをお勧めします。

次の例は、​`<websocket:client-settings>`​ を使用して 1 時間のアイドルソケットタイムアウトを設定する方法を示しています。

```xml
<websocket:config name="wsServer">
    <websocket:connection>
       <websocket:client-settings
         host="localhost"
         port="${listenerPort}"
         basePath="/ws"
         connectionIdleTimeout="1"
         connectionIdleTimeoutUnit="HOURS" />
    </websocket:connection>
</websocket:config>
```

デフォルトでは、アウトバウンドソケットにアイドルタイムアウトは設定されていません。ただし、接続先のリモートサービスには設定されていることが多いです。

### [](#結合された設定)結合された設定

アプリケーションで受信接続のリスンと外部サービスへの要求の発行の両方を行う場合、サーバーとクライアントを一緒に設定できます。

```xml
<http:listener-config
   name="httpListenerConfig"
   basePath="/willBeOverriddenByWSConfig">
   <http:listener-connection host="0.0.0.0" port="${listenerPort}" />
</http:listener-config>

<websocket:config name="ws">
    <websocket:connection>
       <websocket:server-settings
         listenerConfig="httpListenerConfig"
         listenerBasePath="/ws" />
       <websocket:client-settings
         host="localhost"
         port="80"
         basePath="/ws" />
    </websocket:connection>
</websocket:config>
```

この設定は、インバウンドソケットとアウトバウンドソケットの両方から参照できます。

```xml
<flow="acceptIncomingMessagesFlow">
    <websocket:inbound-listener path="/quotes" config-ref="ws" />
    <logger info="INFO" message="I listen for incoming messages at '/quotes'!"/>
</flow>

<flow="connectToWebSocketFlow">
    <websocket:open-outbound-socket path="/chat" config-ref="ws"/>
    <logger
      info="INFO"
      message="Open a connection to an external service listening at path '/chat'!"/>
</flow>
```

### [](#tls-設定)TLS 設定

TLS (トランスポート層セキュリティ) を使用すると、クライアントアプリケーションとサーバーアプリケーションは安全なチャネルを介して通信でき、攻撃者による送信データの傍受や改ざんを防ぐことができます。

WebSockets サーバーの場合、参照される HTTP リスナー設定から TLS 設定が継承されます。たとえば、WebSockets リスナーで TLS を設定するには、TLS が設定された ​`<http:listener-config>`​ を参照します。

まず、トラストストア (アプリケーションが外部サービスと接続する場合) またはキーストア (アプリケーションが受信接続をリスンする場合)、あるいはその両方をセットアップする必要があります。

次の例では、WebSockets サーバーが HTTP リスナーから TLS 設定を継承し、​`<tls:context>`​ を参照してキーストアを設定します。

```xml
<tls:context name="listenerTlsContext" >
    <tls:key-store
      path="tls/muleKeystore"
      keyPassword="mulepassword"
      password="mulepassword"
      alias="muleserver" />
</tls:context>

<http:listener-config name="listenerTlsConfig">
    <http:listener-connection
      protocol="HTTPS"
      host="localhost"
      port="${listenerPort}"
      tlsContext="listenerTlsContext"/>
</http:listener-config>

<websocket:config name="requestConfigWithCertificate">
    <websocket:connection>
        <websocket:server-settings
         listenerConfig="listenerTlsConfig"
         listenerBasePath="/"/>
    </websocket:connection>
</websocket:config>
```

WebSocket クライアントの場合、​`tlsConfig`​ プロパティで ​`<tls:context>`​ を直接参照してトラストストアをセットアップできます。

```xml
<tls:context name="requestTlsContextWithCertificate" >
    <tls:trust-store path="tls/trustStore" password="mulepassword" />
</tls:context>

<websocket:config name="requestConfigWithCertificate">
    <websocket:connection>
        <websocket:client-settings
         host="localhost"
         port="${listenerPort}"
         tlsContext="requestTlsContextWithCertificate"
         protocol="WSS"/>
    </websocket:connection>
</websocket:config>
```

`protocol`​ パラメーターは省略可能で、デフォルトは WS (安全ではない) です。​`WSS`​ に設定すると、接続で SSL が有効になります。​`<tls:content>`​ が指定されている場合、SSL セッションの作成にその設定が使用されます。それ以外の場合、デフォルト設定が使用されます。

## [](#次のステップ)次のステップ

これで設定が完了したので、WebSockets ​[例](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-examples)​を試すことができます。

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [CloudHub](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-cloudhub)
- [XML と Maven](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-xml-maven)

<!-- document id=ad7aff8207c7e03ccf43c12c3e130a570e275460d2b5a060065c91fbff0bc87d url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-reference.md -->

# 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)デフォルト設定

デフォルト設定の名前および接続種別を設定します。

#### [](#パラメーター)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name (名前)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この設定の名前。コネクタはこの名前の設定を参照します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Connection (接続)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Config_Connection">Connection (接続)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この設定に指定する接続型。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name (名前)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
</tbody>
</table>

#### [](#接続種別)接続種別

##### [](#Config_Connection)Connection (接続)

接続のサーバー、クライアント、および再接続パラメーターを設定します。

###### [](#パラメーター-2)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Server Settings (サーバー設定)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketServerSettings">WebSocket Server Settings (WebSocket サーバー設定)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Client Settings (クライアント設定)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketClientSettings">WebSocket Client Settings (WebSocket クライアント設定)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection (再接続)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Reconnection">Reconnection (再接続)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​<code>true</code>​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

## [](#操作)操作

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 (ブロードキャスト)

`<websocket:broadcast>`

パス、socketType、グループ条件に一致するすべてのアクティブな WebSockets にコンテンツを送信します。パスの場合、インバウンドとアウトバウンドソケットの両方を対象にできるため、設定済みのベースパスは考慮されません。

一部のソケットへの配信に失敗する可能性があったとしても、メッセージは一致するすべてのソケットに送信されます。この操作は、各失敗の詳細が含まれる ​`BroadcastFailure`​ のリストを返します。いずれも失敗しなかった場合は、空のリストが返されます。

### [](#パラメーター-3)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Content (コンテンツ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Binary (バイナリ)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">送信するコンテンツ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">#[payload]</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">一致するソケットのパス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Socket Type (ソケット種別)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>INBOUND</p>
</li>
<li>
<p>OUTBOUND</p>
</li>
<li>
<p>ALL (すべて)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">一致するソケットの種別。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ALL</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Groups (グループ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">これらのグループのいずれかに属すソケットに一致する。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">#[payload]</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#BroadcastFailure">ブロードキャストの失敗</a>​ の配列</p></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合)次の設定の場合

- [デフォルト設定](#Config)

### [](#スロー)スロー

- WEBSOCKET:CONNECTIVITY
- WEBSOCKET:RETRY\_EXHAUSTED

## [](#BulkCloseSockets)Bulk Close Sockets

`<websocket:bulk-close-sockets>`

### [](#パラメーター-4)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Socket Type (ソケット種別)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>INBOUND</p>
</li>
<li>
<p>OUTBOUND</p>
</li>
<li>
<p>ALL (すべて)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ALL (すべて)</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Groups (グループ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Close Code (クローズコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NORMAL_CLOSURE​</p>
</li>
<li>
<p>ENDPOINT_GOING_DOWN​</p>
</li>
<li>
<p>PROTOCOL_ERROR​</p>
</li>
<li>
<p>INVALID_DATA​</p>
</li>
<li>
<p>MESSAGE_TOO_LARGE</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">NORMAL_CLOSURE</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">理由</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-2)次の設定の場合

- [デフォルト設定](#Config)

### [](#スロー-2)スロー

- WEBSOCKET:CONNECTIVITY
- WEBSOCKET:RETRY\_EXHAUSTED

## [](#CloseSocket)Close Socket

`<websocket:close-socket>`

この操作でソケットが閉じられる。

### [](#パラメーター-5)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Socket Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">閉じるソケットの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Close Code (クローズコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NORMAL_CLOSURE​</p>
</li>
<li>
<p>ENDPOINT_GOING_DOWN​</p>
</li>
<li>
<p>PROTOCOL_ERROR​</p>
</li>
<li>
<p>INVALID_DATA​</p>
</li>
<li>
<p>MESSAGE_TOO_LARGE</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クローズコード。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">NORMAL_CLOSURE</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">理由</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">閉じる理由を示す語句。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-3)次の設定の場合

- [デフォルト設定](#Config)

### [](#スロー-3)スロー

- WEBSOCKET:CONNECTIVITY
- WEBSOCKET:NO\_SUCH\_SOCKET
- WEBSOCKET:RETRY\_EXHAUSTED

## [](#OpenOutboundSocket)Open Outbound Socket

`<websocket:open-outbound-socket>`

この操作で新しいアウトバウンドソケットが開かれる。

### [](#パラメーター-6)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Socket Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default Groups (デフォルトグループ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ソケットが最初にサブスクライブするグループ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">要求の送信先となるパス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">URL</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">要求の送信先となる URL。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Headers (ヘッダー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">メッセージに含まれる必要がある HTTP ヘッダー。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">URI パラメーター</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">要求の作成に使用する URI パラメーター。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">クエリパラメーター</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">要求に含まれる必要があるクエリパラメーター。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">#[payload]</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力-2)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketAttributes">WebSocket 属性</a></p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-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 (送信)

`<websocket:send>`

指定されたソケットを通じてコンテンツを送信する。

### [](#パラメーター-7)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Socket Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">データの送信に使用するソケットの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Content (コンテンツ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Binary (バイナリ)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">送信するコンテンツ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">#[payload]</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-5)次の設定の場合

- [デフォルト設定](#Config)

### [](#スロー-5)スロー

- WEBSOCKET:CONNECTIVITY
- WEBSOCKET:NO\_SUCH\_SOCKET
- WEBSOCKET:RETRY\_EXHAUSTED

## [](#ソース)ソース

## [](#InboundListener)On New Inbound Message

`<websocket:inbound-listener>`

外部システムが WebSocket を通じて接続できるエンドポイントを公開します。このソースは、こうした WebSockets がこのサーバーに情報を送信するたびに所有フローをトリガーします。さらに、ソケット接続が確立されるとパスが一致する ​`websocket:on-inbound-connection`​ コンポーネントがトリガーされます。

### [](#パラメーター-8)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">設定で指定されたパスからの相対パス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default Groups (デフォルトグループ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">新規作成されたソケットが最初にサブスクライブするグループ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Primary Node Only (プライマリノードのみ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Redelivery Policy (再配信ポリシー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#RedeliveryPolicy">Redelivery Policy (再配信ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">同じメッセージの再配信を処理するためのポリシー。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力-3)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#InboundWebSocketAttributes">インバウンド WebSocket 属性。</a></p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-6)次の設定の場合

- [デフォルト設定](#Config)

## [](#OnInboundConnection)On New Inbound Connection

`<websocket:on-inbound-connection>`

インバウンド WebSocket 接続が確立されたときにトリガーされます。

### [](#パラメーター-9)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">設定で指定されたパスからの相対パス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Primary Node Only (プライマリノードのみ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Redelivery Policy (再配信ポリシー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#RedeliveryPolicy">Redelivery Policy (再配信ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">同じメッセージの再配信を処理するためのポリシー。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力-4)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketAttributes">WebSocket 属性</a></p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-7)次の設定の場合

- [デフォルト設定](#Config)

## [](#OnSocketClosed)On Socket Closed

`<websocket:on-socket-closed>`

WebSocket が閉じられたときにトリガーされる。

### [](#パラメーター-10)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">設定で指定されたパスからの相対パス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Primary Node Only (プライマリノードのみ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Redelivery Policy (再配信ポリシー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#RedeliveryPolicy">Redelivery Policy (再配信ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">同じメッセージの再配信を処理するためのポリシー。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力-5)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#ClosedConnectionEvent">終了された接続イベント。</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketAttributes">WebSocket 属性</a></p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-8)次の設定の場合

- [デフォルト設定](#Config)

## [](#OutboundListener)On New Outbound Message

`<websocket:outbound-listener>`

アウトバウンドソケットがメッセージを受信したときにトリガーされる。

### [](#パラメーター-11)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">設定で指定されたパスからの相対パス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Config Ref (設定参照)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigurationProvider</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンポーネントを実行するために使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Primary Node Only (プライマリノードのみ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クラスターでの実行時にこのソースをプライマリノード上でのみ実行する必要があるかどうか。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Redelivery Policy (再配信ポリシー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#RedeliveryPolicy">Redelivery Policy (再配信ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">同じメッセージの再配信を処理するためのポリシー。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#出力-6)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#WebSocketAttributes">WebSocket 属性</a></p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#次の設定の場合-9)次の設定の場合

- [デフォルト設定](#Config)

## [](#型)型

### [](#WebSocketServerSettings)WebSocket Server Settings (WebSocket サーバー設定)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Listener Base Path (リスナーベースパス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>この設定を通じて処理されるすべてのリソースに使用するベースパス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>/</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>リスナー設定</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>インバウンドエンドポイントを公開するために使用される ​<code>http:listener-config</code>​ への参照。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Idle Socket Timeout (アイドルソケットタイムアウト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>自動的に閉じるアイドル WebSockets のタイムアウト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>15</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Idle Socket Timeout Unit (アイドルソケットタイムアウト単位)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NANOSECONDS</p>
</li>
<li>
<p>MICROSECONDS</p>
</li>
<li>
<p>MILLISECONDS</p>
</li>
<li>
<p>SECONDS</p>
</li>
<li>
<p>MINUTES</p>
</li>
<li>
<p>HOURS</p>
</li>
<li>
<p>DAYS</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#idleSocketTimeout を評価する時間単位。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>MINUTES</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#WebSocketClientSettings)WebSocket Client Settings (WebSocket クライアント設定)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Host (ホスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求が送信されるホスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Port (ポート)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求が送信されるポート。プロトコル属性が WS (デフォルト) の場合、デフォルト値は ​<code>80</code>​ です。プロトコル属性が WSS の場合、デフォルト値は ​<code>443</code>​ です。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Base Path (ベースパス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>この設定を参照するすべてのアウトバウンドソケットに使用するベースパス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>/</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Protocol (プロトコル)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>WS</p>
</li>
<li>
<p>WSS</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アウトバウンド通信に使用するプロトコル。有効な値は ​<code>WS</code>​ と ​<code>WSS</code>​ です。デフォルト値は ​<code>WS</code>​ です。WSS を使用すると、HTTP 通信が TLS/SSL を使用して保護されます。WSS がプロトコルとして設定された場合、ユーザーは ​<code>tls:context</code>​ パラメーターを定義することで TLS/SSL 設定をカスタマイズできます。​<code>tls:context</code>​ が定義されていない場合、デフォルトの JVM 証明書が通信の確立に使用されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>WS</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Tls Context (TLS コンテキスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Tls">TLS</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アウトバウンドソケットの WSS を有効にする TLS 設定要素への参照。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Default Headers (デフォルトヘッダー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Header">Header (ヘッダー)</a>​ の配列</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>メッセージに含まれる必要があるデフォルト HTTP ヘッダー。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Default Query Params (デフォルトクエリパラメーター)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#QueryParam">Query Param (クエリパラメーター)</a>​ の配列</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>応答に含まれる必要があるデフォルトクエリパラメーター。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Connection Idle Timeout (接続アイドルタイムアウト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アイドル接続が終了されるタイムアウト。指定しない場合、タイムアウトはありません。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Connection Idle Timeout Unit (接続アイドルタイムアウト単位)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NANOSECONDS</p>
</li>
<li>
<p>MICROSECONDS</p>
</li>
<li>
<p>MILLISECONDS</p>
</li>
<li>
<p>SECONDS</p>
</li>
<li>
<p>MINUTES</p>
</li>
<li>
<p>HOURS</p>
</li>
<li>
<p>DAYS</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#connectionIdleTimeout を評価する時間単位。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>MINUTES</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Follow Redirects (リダイレクトをフォロー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>リダイレクトをフォローするかどうかを示します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>true</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Preserve Headers Case (ヘッダーの文字を保持)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>デフォルトでは、ヘッダーキーは内部的に小文字で保存されます。これは、ヘッダー処理のパフォーマンス向上が目的で、RFC の仕様どおりに正しく機能します。</p>
</div>
<div class="literalblock">
<div class="content">
<pre>サーバーが特定の文字のヘッダーを期待している場合、このフラグを ​`true`​ に設定してヘッダーキーの文字を保持します。</pre>
</div>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>false</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Max Connections (最大接続数)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>同時に開いた状態にできるアウトバウンド接続の最大数。デフォルトでは、接続数は無制限です。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>-1</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Proxy Config (プロキシ設定)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="#Proxy">Proxy (プロキシ)</a>​</p>
</li>
<li>
<p><a href="#NtlmProxy">NTLM Proxy (NTLM プロキシ)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシ経由のアウトバウンド接続の再利用可能な設定要素。プロキシ要素では、必ずホスト名およびポート属性を定義し、必要に応じてユーザー名とパスワードを定義できます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Authentication (認証)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>HttpRequestAuthentication</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>HTTP 要求で使用する認証方式。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#Tls)TLS

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Enabled Protocols (有効化されたプロトコル)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>このコンテキストで有効化されたプロトコルのカンマ区切りリスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Enabled Cipher Suites (有効化された暗号化スイート)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trust Store (トラストストア)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#TrustStore">トラストストア</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Key Store (キーストア)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#KeyStore">Key Store (キーストア)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Revocation Check (取り消し確認)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#StandardRevocationCheck">Standard Revocation Check (標準の取り消し確認)</a>​</p>
</li>
<li>
<p><a href="#CustomOcspResponder">Custom Ocsp Responder (カスタム Ocsp レスポンダー)</a>​</p>
</li>
<li>
<p><a href="#CrlFile">CRL File (CRL ファイル)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#TrustStore)トラストストア

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Path (パス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Password (パスワード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>トラストストアを保護するために使用するパスワード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type (型)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>使用するストアの型。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Algorithm (アルゴリズム)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>トラストストアで使用するアルゴリズム。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Insecure (安全ではない)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>true</code>​ に設定した場合、証明書の検証が行われず、攻撃に対して脆弱な接続がレンダリングされます。各自の責任で使用してください。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#KeyStore)Key Store (キーストア)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Path (パス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type (型)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>使用するストアの型。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Alias (別名)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>キーストアに多数の非公開キーが含まれている場合は、この属性によって使用するキーの別名を示します。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Key Password (キーパスワード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>非公開キーを保護するために使用するパスワード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Password (パスワード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>キーストアを保護するために使用するパスワード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Algorithm (アルゴリズム)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>キーストアで使用するアルゴリズム。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#StandardRevocationCheck)Standard Revocation Check (標準の取り消し確認)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Only End Entities (最後のエンティティのみ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>証明書チェーンの最後の要素のみを確認します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Prefer Crls (CRL を優先)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>最初に CRL を試みます (OCSP ではない)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>No Fallback (代替なし)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>第 2 の確認方法 (以前に選択されていない方法) を使用しません。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Soft Fail (ソフトフェール)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#CustomOcspResponder)Custom Ocsp Responder (カスタム Ocsp レスポンダー)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Url</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>OCSP レスポンダーの URL。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Cert Alias (証明書の別名)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#CrlFile)CRL File (CRL ファイル)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Path (パス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>CRL ファイルへのパス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#Header)Header (ヘッダー)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Key (キー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Value (値)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#QueryParam)Query Param (クエリパラメーター)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Key (キー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Value (値)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#Reconnection)Reconnection (再接続)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Fails Deployment (デプロイメントに失敗)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Reconnection Strategy (再接続戦略)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#Reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#ReconnectForever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>使用する再接続戦略。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#Reconnect)Reconnect (再接続)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Frequency (頻度)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>再接続する頻度 (ミリ秒)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Blocking</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Count (数)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>再接続の試行回数。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#ReconnectForever)Reconnect Forever (繰り返し再接続)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Frequency (頻度)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>再接続する頻度 (ミリ秒)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Blocking</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#InboundWebSocketAttributes)インバウンド WebSocket 属性。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>バージョン</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の HTTP バージョン。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Local Address (ローカルアドレス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>サーバーからのローカルホストアドレス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Remote Address (リモートアドレス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>送信者からのリモートホストアドレス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Client Certificate (クライアント証明書)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Any (任意)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クライアント証明書 (双方向 TLS が有効な場合)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Socket Id</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ソケット ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Socket Type (ソケット種別)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>INBOUND</p>
</li>
<li>
<p>OUTBOUND</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ソケット種別。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Groups (グループ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>このソケットがサブスクライブされるグループ。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Path (パス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求が受信された場所のフルパス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Request Uri (要求 URI)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の完全 URI。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Schema (スキーマ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>WS</p>
</li>
<li>
<p>WSS</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の HTTP スキーム。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Query Params (クエリパラメーター)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>解析した文字列からビルドしたクエリパラメーターのマッピング。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Headers (ヘッダー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>解析した文字列からビルドしたヘッダーのマッピング。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Uri Params (URI パラメーター)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求パスから抽出した URI パラメーター。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Method (メソッド)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の HTTP メソッド。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Query String (クエリ文字列)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求のクエリ文字列。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#RepeatableInMemoryStream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Initial Buffer Size (初期バッファサイズ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Buffer Size Increment (バッファサイズ増分)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​<code>STREAM_MAXIMUM_SIZE_EXCEEDED</code>​ エラーが発生します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Max Buffer Size (最大バッファサイズ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>使用するメモリの最大量。これを超えると、​<code>STREAM_MAXIMUM_SIZE_EXCEEDED</code>​ エラーが発生します。0 以下の値は無制限を意味します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Buffer Unit (バッファ単位)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>BYTE (バイト)</p>
</li>
<li>
<p>KB</p>
</li>
<li>
<p>MB</p>
</li>
<li>
<p>GB</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>これらのすべての属性の単位</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#RepeatableFileStoreStream)Repeatable File Store Stream (反復可能なファイルストアストリーム)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>In Memory Size (メモリ内サイズ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Buffer Unit (バッファ単位)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>BYTE (バイト)</p>
</li>
<li>
<p>KB</p>
</li>
<li>
<p>MB</p>
</li>
<li>
<p>GB</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>maxInMemorySize で表される単位</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Max Redelivery Count (最大再配信数)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロセス失敗メッセージをトリガーするまでに、正常に処理されないメッセージを再配信できる最大回数。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Message Digest Algorithm (メッセージダイジェストアルゴリズム)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>使用するセキュアハッシュアルゴリズム。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>SHA-256</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Message Identifier (メッセージ識別子)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>メッセージを識別するために使用される戦略を定義します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Object Store (オブジェクトストア)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ObjectStore</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>各メッセージの再配信カウンターが保存されるオブジェクトストア。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

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

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Use Secure Hash (セキュアハッシュを使用)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Id Expression (ID 式)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#WebSocketAttributes)WebSocket 属性

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Socket Id</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ソケット ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Socket Type (ソケット種別)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>INBOUND</p>
</li>
<li>
<p>OUTBOUND</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ソケット種別。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Groups (グループ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Array of String (文字列の配列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>このソケットがサブスクライブされるグループ。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Path (パス)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求が受信された場所のフルパス。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Request Uri (要求 URI)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の完全 URI。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Schema (スキーマ)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>WS</p>
</li>
<li>
<p>WSS</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の HTTP スキーム。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Query Params (クエリパラメーター)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>解析した文字列からビルドしたクエリパラメーターのマッピング。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Headers (ヘッダー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>解析した文字列からビルドしたヘッダーのマッピング。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Uri Params (URI パラメーター)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求パスから抽出した URI パラメーター。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Method (メソッド)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求の HTTP メソッド。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Query String (クエリ文字列)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>要求のクエリ文字列。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#ClosedConnectionEvent)終了された接続イベント。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Code (コード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NORMAL_CLOSURE​</p>
</li>
<li>
<p>ENDPOINT_GOING_DOWN​</p>
</li>
<li>
<p>PROTOCOL_ERROR​</p>
</li>
<li>
<p>INVALID_DATA​</p>
</li>
<li>
<p>MESSAGE_TOO_LARGE</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クローズコード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>理由</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ソケットが閉じられた理由が含まれる語句。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#BroadcastFailure)ブロードキャストの失敗

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>エラーメッセージ</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>例外</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Any (任意)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Socket Id</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type (型)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>INBOUND</p>
</li>
<li>
<p>OUTBOUND</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Uri</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#Proxy)Proxy (プロキシ)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Host (ホスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシ要求が送信されるホスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Port (ポート)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシ要求が送信されるポート。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Username (ユーザー名)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシに対して認証するユーザー名。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Password (パスワード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシに対して認証するパスワード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Non Proxy Hosts (非プロキシホスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシの使用対象にならないカンマ区切りホストのリスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

### [](#NtlmProxy)NTLM Proxy (NTLM プロキシ)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Ntlm Domain (NTLM ドメイン)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシに対して認証するドメイン。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Host (ホスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシ要求が送信されるホスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Port (ポート)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシ要求が送信されるポート。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Username (ユーザー名)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシに対して認証するユーザー名。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Password (パスワード)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシに対して認証するパスワード。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Non Proxy Hosts (非プロキシホスト)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>プロキシの使用対象にならないカンマ区切りホストのリスト。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

## [](#関連情報)関連情報

- [WebSocket Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=23f9dca161d4238219a3a9c6e3ae96a464e346c8c35498e53e8c9a66dbded7d7 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-server-components.md -->

# WebSockets サーバーコンポーネント

## [](#inbound-listener)Inbound Listener

Inbound Listener コンポーネントは、クライアントが接続できる WebSocket エンドポイントを表します。このエンドポイントを参照して、外部クライアントは WebSocket 接続を確立し、メッセージを送信するたびにフローをトリガーします。

クライアントは、defaultGroups パラメーターでこのエンドポイントが自動的にサブスクライブするデフォルトのグループを示すこともできます。こうしたグループに対してブロードキャスト操作が実行された場合、このエンドポイントが受信して処理します。このサブスクリプションはアプリケーションドメイン内で実行されます。つまり、デフォルトのグループパラメーターを追加しても対応するアウトバウンド WebSocket にこのサブスクリプションに関する情報が送信されません。これは、グループの機能が WS プロトコルの一部ではないためです。グループに対するインバウンド WebSocket をサブスクライブする場合、アプリケーションドメイン内の 1 つの WebSocket がその他のすべての WebSockets にメッセージを送信するには、アプリケーションドメインも指定されたグループにサブスクライブされている必要があります。要するに、グループのサブスクリプションは同じアプリケーションドメイン内にある WebSockets のみに影響を及ぼし、外部アプリケーションの WebSockets は Mule アプリケーションによって他のグループにサブスクライブされません。

```xml
<flow name="onIncomingMessageFlow">
    <websocket:inbound-listener
        path="/chat"
        defaultGroups="#[['AVENGERS', 'REVENGERS']]"
        config-ref="ws" />
    <logger
        level="INFO"
        message="#['Received message ' ++ payload ++ ' from socket: ' ++ attributes.socketId]" />

    <websocket:send
        doc:name="SendResponse"
        socketId="#[attributes.socketId]"
        config-ref="ws" >
        <websocket:content>#['I'm fine, thank you!']</websocket:content>
    </websocket:send>
</flow>

<flow name="sendFriendlyMessageFlow">
    <websocket:open-outbound-socket path="/chat" config-ref="ws" />

    <websocket:send
        doc:name="SendMessage"
        socketId="#[attributes.socketId]"
        config-ref="ws" >
        <websocket:content>#['Hi! How are you?']</websocket:content>
    </websocket:send>
</flow>
```

## [](#応答の送信)応答の送信

フローが終了したときに自動的に応答を送信する ​`<http:listener>`​ 要素とは異なり、このコンポーネントが自動的に応答を送信することはありません。これは、WebSocket プロトコルが全二重であり、そのために、応答を送信する必要があるまたは送信することを希望することが保証されないためです。ユースケースに応じて、応答を送信せずにメッセージを処理することを希望する場合もあれば、特定のケースに関する応答のみを送信することを希望する場合もあります。

応答を送信するには、​`<websocket:send>`​ 操作を使用します。

### [](#出力)出力

新しいメッセージが到着するたびに、フローがメッセージを使用してトリガーされ、ペイロードにメッセージのコンテンツが含まれます。メッセージの MIME タイプは HTTP 要求の ​`Content-Type`​ ヘッダーから取得されます。MIME タイプが設定されていない場合、MIME タイプのデフォルトはプロトコルの DataFrame タイプに応じて次のいずれかになります。

- バイナリの場合、MIME のデフォルトは ​`application/octect-stream`​ になります。
- テキストの場合、MIME のデフォルトは ​`text/plain`​ になります。

属性には WebSockets 属性オブジェクトが含まれています。

## [](#インバウンド接続)インバウンド接続

これは、INBOUND WebSockets 接続が確立されるたびにトリガーされるメッセージソースです。1 つのパスに指定できるのは次のソースのうちいずれか 1 つであり、そのパスで一致するインバウンドリスナーが存在する必要があります。これは、ソケットの記録やソケットへのグループの割り当てなど、接続後のタスクを実行するために便利です。

このフローは同期的にトリガーされます。このフローが呼び出されるまでに、ソケットはすでに確立されていて、メッセージをブロードキャストまたは受信する可能性もあります。こうしたメッセージはキューに登録され、ソースによってトリガーされたイベントが完了するまでフローに配信されません。失敗すると、キューに登録されたすべてのメッセージが破棄され、接続がドロップされます。

このメッセージソースには主に 2 つのユースケースがあります。

- 後で使用するために生成されたソケット ID を追跡する
- WebSockets がアプリケーションで使用できるようになる前に拒否できる検証ポイントを設定する

たとえば、次のフローでは要求の発生元の属性を検証し、検証に合格しなかった場合に接続を終了することを決定します。

```xml
<flow name="onNewInboundConnection">
    <websocket:on-inbound-connection
        doc:name="On Inbound Connection"
        config-ref="WebSockets_Config"
        path="/chat"/>
    <choice doc:name="Choice" >
        <when expression="#[contains(attributes.headers.alias, 'admin')]">
            <websocket:close socketId="#[attributes.socketId]"
                reason="Cannot impersonate the admin"
                config-ref="WebSockets_Config"/>
        </when>
        <otherwise >
            <logger
                level="INFO"
                doc:name="Logger"
                message="Successfully connected to WebSocket #[attributes.socketId]" />
        </otherwise>
    </choice>
</flow>

<flow name="chat">
    <websocket:inbound-listener
        doc:name="Inbound listener"
        path="/chat"
        config-ref="WebSockets_Config"/>
    <logger
        level="INFO"
        doc:name="Logger"
        message="#['Received message' ++ payload]"/>
</flow>
```

## [](#関連情報)関連情報

- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [サーバーコンポーネント](#)
- [メッセージング操作](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-messaging-operations)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=a11e2524146bea157e50681fb1ed920318ec9ad5ff33f469bd296bbb9005cbe7 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-studio.md -->

# WebSockets の Studio 設定

Anypoint Studio でコネクタを設定する手順は、次のとおりです。

1. コネクタを Studio プロジェクトに追加します。
2. コネクタを設定します。
3. コネクタの入力元を設定します。

## [](#studio-プロジェクトへのコネクタの追加)Studio プロジェクトへのコネクタの追加

Anypoint Studio には、Studio プロジェクトにコネクタを追加する 2 つの方法があります。Studio タスクバーの Exchange ボタンから追加するか、\[Mule Palette (Mule パレット)\] ビューから追加します。

### [](#exchange-を使用してコネクタを追加する)Exchange を使用してコネクタを追加する

1. Studio で Mule プロジェクトを作成します。
2. Studio タスクバーの左上にある Exchange アイコン ​**(X)**​ をクリックします。
3. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。
4. Exchange で「websockets」を検索します。
5. コネクタを選択して ​**\[Add to project (プロジェクトに追加)\]**​ をクリックします。
6. 画面の指示に従ってコネクタをインストールします。

### [](#studio-でコネクタに追加する)Studio でコネクタに追加する

1. Studio で Mule プロジェクトを作成します。
2. \[Mule Palette (Mule パレット)\] ビューで、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。
3. **\[Add Modules to Project (モジュールをプロジェクトに追加)\]**​ で、検索項目に「websockets」と入力します。
4. **\[Available modules (使用可能なモジュール)\]**​ で、このコネクタの名前をクリックします。
5. **\[Add (追加)\]**​ をクリックします。
6. **\[Finish (完了)\]**​ をクリックします。

## [](#コネクタの設定)コネクタの設定

1. **\[Global Elements (グローバル要素)\]**​ タブに移動して、​**\[Create (作成)\]**​ をクリックします。
2. **\[Connector Configuration (コネクタ設定)\]**​ から、​**\[WebSockets Config (WebSockets 設定)\]**​ を選択します。
3. コネクタで受信要求をリスンするには、​**\[Configure Inbound WebSocket (インバウンド WebSocket を設定)\]**​ セクションをオンにします。  
    外部サービスに対する要求を実行するには、​**\[Configure Outbound WebSocket (アウトバウンド WebSocket を設定)\]**​ セクションをオンにします。  
    アプリケーションでインバウンド接続とアウトバウンド接続の両方を実行する場合は両方のセクションをオンにできます。

### [](#インバウンド-websockets-の設定)インバウンド WebSockets の設定

1. **\[Global Elements (グローバル要素)\]**​ タブに移動して、​**\[Create (作成)\]**​ をクリックします。
2. **\[Connector Configuration (コネクタ設定)\]**​ から、​**\[HTTP Listener Config (HTTP リスナー設定)\]**​ を選択します。
3. WebSockets 設定で、​**\[Server settings (サーバー設定)\]**​ ボックスをオンにします。
4. リスナーベースパスを指定して (省略可能)、以前に作成した HTTP リスナー設定を参照します。

### [](#アウトバウンド-websockets-の設定)アウトバウンド WebSockets の設定

1. WebSockets 設定で、​**\[Client settings (クライアント設定)\]**​ ボックスをオンにします。
2. 次の省略可能なプロパティを指定します。  
    
    - Host (ホスト)
    - Port (ポート)
    - Path (パス)
3. **\[Default Headers (デフォルトヘッダー)\]**​ および ​**\[Query Parameters (クエリパラメーター)\]**​ セクションで、ドロップダウンリストからオプションを選択することでヘッダーおよびクエリパラメーターのデフォルト値を導入できます。
    
    1. **\[Expression (式)\]**​ を選択して ​`dwl`​ 式を入力します。
    2. **\[Edit Inline (インラインで編集)\]**​ をクリックして、\[+\] 記号をクリックしてキーと値のペアを入力します。

## [](#入力元を設定する)入力元を設定する

コネクタの入力元を設定します。

コネクタの次の操作を Studio キャンバスの ​**\[Source (ソース)\]**​ 領域に配置できます。

- Inbound Listener
- On Outbound Socket Message
- On Inbound Connection (Inbound Listener が必要)
- On Socket Closed

## [](#次のステップ)次のステップ

これで Studio の設定が完了しましたので、​[「コネクタの設定」](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)​で他の設定に関する情報を確認してください。

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [XML と Maven の設定](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-xml-maven)

<!-- document id=49508e31d3af65eaa369315083f68f70ea3969b33d5682476c05ae1cdbbff389 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-reconnection.md -->

# WebSockets の再接続

WebSockets は永続的でステートフルな接続に基づきます。接続は確立されてから操作に使用している間に、アイドルタイムアウトやネットワーク状態などの要因により、不意に切断される場合があります。

接続を再確立するにはリモートシステムが接続要求を再送信する必要があるため、インバウンドソケットは自動的に再接続できません。

ただし、アウトバウンドソケットの場合は、接続がドロップされた場合に再接続ポリシーを使用して接続を再確立することができます。

Mule アプリケーションが、たとえばメッセージをソケットに送信するために、不意に終了された WebSocket を使用しようとした場合、最初にアウトバウンドソケットを確立したのと同じ HTTP 要求を再生することで、接続が再確立されます。その後、操作が自動的に再試行されます。

次の例は、接続がドロップされた場合に、1 秒に 1 回ずつ、最大 5 回再接続を試みるように ​`<websocket:send>`​ 操作を使用して再接続ポリシーを送信する方法を示しています。

```xml
<websocket:send socketId="#[vars.socketId]" config-ref="ws">
    <reconnect count="5" frequency="1000"/>
    <websocket:content>Hello World!</websocket:content>
</websocket:send>
```

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [Connector Configuration (コネクタ設定)](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)

<!-- document id=66fe0b4067ed4266913ece7c24f89ab40e0835bee3451d5ee81415cbda44535e url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-messaging-operations.md -->

# WebSockets メッセージング操作

## [](#send-操作)Send 操作

Send 操作により、接続が確立された後にそのソケット ID によって識別される WebSocket を通じてメッセージを送信できます。この操作は、インバウンドとアウトバウンドの両方の WebSocket インスタンスで使用できます。

```xml
    <flow name="sayHello">
      <websocket:open-outbound-socket
        path="/chat/hello"
        config-ref="ws"
        target="socketId"
        targetValue="#[attributes.socketId]"/>
      <websocket:send socketId="#[vars.socketId]" config-ref="ws">
        <websocket:content>'Good morning!'</websocket:content>
      </websocket:send>
    </flow>

    <flow name="sayHelloBack">
        <websocket:inbound-listener
            path="/chat/hello"
            config-ref="ws"
            outputMimeType="text/plain" />
        <websocket:send socketId="#[attributes.socketId]" config-ref="ws">
            <websocket:content>#['Good morning ' ++ attributes.socketId ++ '!']</websocket:content>
        </websocket:send>
    </flow>
```

## [](#broadcast-操作)Broadcast 操作

Broadcast 操作はメッセージをソケットのグループに送信します。メッセージをブロードキャストできるソケットのグループを選択する手順は、次のとおりです。

- 特定のグループをサブスクライブする
- 特定のパスに接続する
- 特定の種別にする (INBOUND または OUTBOUND)

種別およびグループパラメーターは連携して加法的に機能します。省略することも個別に使用することもできますが、一緒に使用すると 2 つのレベルの絞り込みとして動作します。

```xml
<!-- Send to all INBOUND sockets connected to the /quotes endpoint, in the MARVEL and DC groups -->
<websocket:broadcast
    doc:name="Broadcast"
    socketType="INBOUND"
    config-ref="WebSockets_Config"
    path="/quotes">
    <websocket:groups >
        <websocket:group value=" #[['MARVEL', 'DC']]" />
    </websocket:groups>
</websocket:broadcast>
```

### [](#出力)出力

Broadcast 操作の出力は void です。

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [グループの管理](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-managing-groups)
- [Connector Configuration (コネクタ設定)](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)

<!-- document id=ffb49bbb558e71629f70fdec95901716811372c3b0c56ae772912cb8ee81827b url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-connection-close.md -->

# WebSockets 接続の終了

この操作は、ソケット ID で参照されている現在接続中の WebSockets を終了します。

```xml
<flow name="closeConnection">
    <websocket:close-socket
        socketId="#[attributes.socketId]"
        reason="Quota exceeded"/>
</flow>
```

## [](#close-の出力)Close の出力

この操作は、ペイロードや属性を返しません。

## [](#on-socket-closed)On Socket Closed

メッセージソースは、WebSocket が終了するたびにフローをトリガーします。これは、クリーンアップ操作、ログ記録、アプリケーションの状態の更新を実行する場合に便利です。

これは非同期です。フローが呼び出されるまでに、ソケットは終了しています。参照される WebSocket を介してメッセージを送信しようとすると、エラーが発生します。

```xml
<flow name="onConnectionClosed">
    <websocket:on-connection-closed path="/chat/*" config-ref="ws" />
    <logger
        level="INFO"
        message="No more messages please: you shall not pass." />
</flow>

<flow name="receiveMessagesFlow">
    <websocket:on-inbound-connection path="/chat" config-ref="ws" />
    <logger
        level="INFO"
        message="Someone just sent a message and now I will close this connection!" />

    <websocket:close-socket
        socketId="#[attributes.socketId]"
        reason="I don't like to talk."
        config-ref="ws" />
</flow>
```

path パラメーターは、終了時にフローをトリガーするソケットのパスを示します。​`catch-all`​ を指定する場合、アスタリスクワイルドカード記号 (∗) を使用できます。

## [](#on-socket-closed-の出力)On Socket Closed の出力

この操作は、空のペイロードと属性の WebSocketAttributes オブジェクトを返します。

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [Reconnection (再接続)](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-reconnection)
- [サーバーコンポーネント](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-server-components)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)

<!-- document id=c1aa9c9ef01289f537613beb2d8461a577ca85823c524101488cbb2d873ea0d1 url=/mulesoft/current/ja-jp/websockets-connector/latest/websockets-connector-managing-groups.md -->

# WebSockets 管理グループ

WebSockets Connector が使用するソケットグループは、WebSockets クライアントが必要に応じてサブスクライブできる文字列 ID です。これは、いわゆるメッセージ分離に便利です。メッセージ分離により、アプリケーションで単一のメッセージを異なる WebSockets クライアントのグループにブロードキャストできます。

グループを利用する方法の例は、ブロードキャスト操作のドキュメントに記載されています。

`<websocket:inbound-listener>`​ トリガーと ​`<websocket:open-outbound-socket>`​ 操作の両方で、デフォルトのグループを指定できます。これは、新規のインバウンドおよびアウトバウンドソケットがすべて自動的にサブスクライブされるグループです。

手動でのサブスクライブまたはグループからのソケットのサブスクライブ解除が必要になるユースケースもあります。たとえば、インバウンド WebSocket が確立されるマルチテナントアプリケーションのユースケースを考えてみましょう。イニシエーターの HTTP 要求には ​`clientId`​ と呼ばれる認証ヘッダーが含まれます。クライアント ID を検証して、クライアントが属する組織を識別する ​`orgId`​ と呼ばれる変数を設定する ​`fetch-client-details`​ と呼ばれるフローをコールします。ソケットがその組織を識別するグループに追加されます。

(組織 ID) にサブスクライブされるグループはランタイムにしか決定できないため、グループサブスクリプションは動的です。

フローの例を次に示します。

```xml
<flow name="onIncomingMessageFlow">
    <websocket:inbound-listener path="/feed" config-ref="ws" />

    <!-- Store relevant information in variables -->
    <set-variable variableName="socketId" value="#[attributes.socketId]" />
    <set-variable variableName="authHeader" value="#[attributes.headers.clientId]" />

    <!-- Validate the auth Header -->
    <flow-ref name="fetch-client-details" />

    <!-- Perform group subscription -->
    <websocket:subscribe-groups
      socketId="#[vars.socketId]"
      groups="#[[vars.orgId]]"
      config-ref="ws" />
</flow>
```

このユースケースの裏側として、グループから動的にサブスクライブ解除する必要もあり、これは ​`<websocket:unsubscribe-groups>`​ 操作を使用して実行できます。

```xml
<websocket:unsubscribe-groups
  socketId="#[vars.socketId]"
  groups="#[[vars.orgId]]"
  config-ref="ws" />
```

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)
- [WebSockets Connector の概要](https://docs.mulesoft.com/jp/websockets-connector/latest/)
- [Connector Configuration (コネクタ設定)](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-config-topics)
- [メッセージング操作](https://docs.mulesoft.com/jp/websockets-connector/latest/websockets-connector-messaging-operations)