ClientWebSocketContainer (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.websocket.IntegrationWebSocketContainer
- - org.springframework.integration.websocket.ClientWebSocketContainer

実装済みのインターフェース一覧:
DisposableBean, Lifecycle, Phased, SmartLifecycle
```
public final class ClientWebSocketContainer
extends IntegrationWebSocketContainer
implements SmartLifecycle
```
client Web-Socket 接続用の IntegrationWebSocketContainer 実装。
内部 ConnectionManagerSupport 実装の構成を表します。
ClientWebSocketContainer.IntegrationWebSocketConnectionManager.openConnection() イベントで clientSession WebSocketSession を受け入れます。これは、getSession(String) を使用してこのコンテナーからアクセスできます。
導入:
4.1
作成者:
Artem Bilan, Gary Russell

フィールド概要
- クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたフィールド
  DEFAULT_SEND_BUFFER_SIZE, DEFAULT_SEND_TIME_LIMIT, logger, sessions, webSocketHandler
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクター概要
コンストラクター
コンストラクターと説明
ClientWebSocketContainer(WebSocketClient client, StringSE uriTemplate, ObjectSE... uriVariables)

コンストラクター
コンストラクターと説明
`ClientWebSocketContainer(WebSocketClient client, StringSE uriTemplate, ObjectSE... uriVariables)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`int`	`getPhase()`
`WebSocketSession`	`getSession(StringSE sessionId)` `clientSession` `WebSocketSession` を返します。
`boolean`	`isAutoStartup()`
`boolean`	`isConnected()` `clientSession` が開いている場合は、`true` を返します。
`boolean`	`isRunning()`
`void`	`setAutoStartup(boolean autoStartup)`
`void`	`setConnectionTimeout(int connectionTimeout)` 接続タイムアウトを秒単位で設定します。デフォルト: 10。
`void`	`setHeaders(HttpHeaders headers)`
`void`	`setHeadersMap(MapSE<StringSE, StringSE> headers)`
`void`	`setOrigin(StringSE origin)`
`void`	`setPhase(int phase)`
`void`	`start()`
`void`	`stop()`
`void`	`stop(RunnableSE callback)`

クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたメソッド
addSupportedProtocols, closeSession, destroy, getSessions, getSubProtocols, setMessageListener, setSendBufferSizeLimit, setSendTimeLimit, setSupportedProtocols

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ClientWebSocketContainer
```
public ClientWebSocketContainer(WebSocketClient client,
                                StringSE uriTemplate,
                                ObjectSE... uriVariables)
```
- メソッドの詳細
  - setOrigin
```
public void setOrigin(StringSE origin)
```
  - setHeadersMap
```
public void setHeadersMap(MapSE<StringSE,StringSE> headers)
```
  - setHeaders
```
public void setHeaders(HttpHeaders headers)
```
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    接続タイムアウトを秒単位で設定します。デフォルト: 10。
    パラメーター:
    connectionTimeout - 秒単位のタイムアウト。
    導入:
    4.2
  - getSession
```
public WebSocketSession getSession(StringSE sessionId)
```
    clientSession WebSocketSession を返します。提供された引数とは関係なく、このメソッドは常に確立された clientSession のみを返します
    オーバーライド:
    クラス IntegrationWebSocketContainer の getSession
    パラメーター:
    sessionId - sessionId。null にすることができます。
    戻り値:
    clientSession（確立されている場合）。
  - setAutoStartup
```
public void setAutoStartup(boolean autoStartup)
```
  - setPhase
```
public void setPhase(int phase)
```
  - isConnected
```
public boolean isConnected()
```
    clientSession が開いている場合は、true を返します。
    戻り値:
    WebSocketSession.isOpen() 状態。
    導入:
    4.2.6
  - isAutoStartup
```
public boolean isAutoStartup()
```
    次で指定:
    インターフェース SmartLifecycle 内の isAutoStartup
  - getPhase
```
public int getPhase()
```
    次で指定:
    インターフェース Phased 内の getPhase
    次で指定:
    インターフェース SmartLifecycle 内の getPhase
  - isRunning
```
public boolean isRunning()
```
    次で指定:
    インターフェース Lifecycle 内の isRunning
  - start
```
public void start()
```
    次で指定:
    インターフェース Lifecycle 内の start
  - stop
```
public void stop()
```
    次で指定:
    インターフェース Lifecycle 内の stop
  - stop
```
public void stop(RunnableSE callback)
```
    次で指定:
    インターフェース SmartLifecycle 内の stop

クラス ClientWebSocketContainer

フィールド概要

クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ClientWebSocketContainer

メソッドの詳細

setOrigin

setHeadersMap

setHeaders

setConnectionTimeout

getSession

setAutoStartup

setPhase

isConnected

isAutoStartup

getPhase

isRunning

start

stop

stop