WebSocketConnectionManager (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.client.ConnectionManagerSupport
- - org.springframework.web.socket.client.WebSocketConnectionManager

実装されたすべてのインターフェース:
Lifecycle, Phased, SmartLifecycle
```
public class WebSocketConnectionManager
extends ConnectionManagerSupport
```
URI、WebSocketClient、WebSocketHandler が指定された WebSocket 接続マネージャーは、ConnectionManagerSupport.start() および ConnectionManagerSupport.stop() メソッドを介して WebSocket サーバーに接続します。ConnectionManagerSupport.setAutoStartup(boolean) が true に設定されている場合、Spring ApplicationContext がリフレッシュされると、これは自動的に行われます。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドサマリー
- クラス org.springframework.web.socket.client.ConnectionManagerSupport から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
WebSocketConnectionManager(WebSocketClient client, WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables)

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`closeConnection()`
`protected WebSocketHandler`	`decorateWebSocketHandler(WebSocketHandler handler)` クラスコンストラクターに提供される WebSocketHandler を飾ります。
`HttpHeaders`	`getHeaders()` WebSocket ハンドシェイクリクエストのデフォルトヘッダーを返します。
`StringSE`	`getOrigin()` 構成された起点を返します。
`ListSE<StringSE>`	`getSubProtocols()` 使用する構成済みサブプロトコルを返します。
`protected boolean`	`isConnected()`
`protected void`	`openConnection()`
`void`	`setHeaders(HttpHeaders headers)` WebSocket ハンドシェイクリクエストに追加するデフォルトのヘッダーを提供します。
`void`	`setOrigin(StringSE origin)` 使用する原点を設定します。
`void`	`setSubProtocols(ListSE<StringSE> protocols)` 使用するサブプロトコルを設定します。
`void`	`startInternal()`
`void`	`stopInternal()`

クラス org.springframework.web.socket.client.ConnectionManagerSupport から継承されたメソッド
getPhase, getUri, isAutoStartup, isRunning, setAutoStartup, setPhase, start, stop, stop

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

- コンストラクターの詳細
  - WebSocketConnectionManager
```
public WebSocketConnectionManager(WebSocketClient client,
                                  WebSocketHandler webSocketHandler,
                                  StringSE uriTemplate,
                                  ObjectSE... uriVariables)
```
- メソッドの詳細
  - decorateWebSocketHandler
```
protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler)
```
    クラスコンストラクターに提供される WebSocketHandler を飾ります。
    デフォルトでは、LoggingWebSocketHandlerDecorator が追加されます。
  - setSubProtocols
```
public void setSubProtocols(ListSE<StringSE> protocols)
```
    使用するサブプロトコルを設定します。構成されている場合、指定されたサブプロトコルは、Sec-WebSocket-Protocol ヘッダーを介したハンドシェイクでリクエストされます。結果の WebSocket セッションには、サーバーが受け入れたプロトコルが含まれます（存在する場合）。
  - getSubProtocols
```
public ListSE<StringSE> getSubProtocols()
```
    使用する構成済みサブプロトコルを返します。
  - setOrigin
```
public void setOrigin(@Nullable
                      StringSE origin)
```
    使用する原点を設定します。
  - getOrigin
```
@Nullable
public StringSE getOrigin()
```
    構成された起点を返します。
  - setHeaders
```
public void setHeaders(HttpHeaders headers)
```
    WebSocket ハンドシェイクリクエストに追加するデフォルトのヘッダーを提供します。
  - getHeaders
```
public HttpHeaders getHeaders()
```
    WebSocket ハンドシェイクリクエストのデフォルトヘッダーを返します。
  - startInternal
```
public void startInternal()
```
    オーバーライド:
    クラス ConnectionManagerSupport の startInternal
  - stopInternal
```
public void stopInternal()
                  throws ExceptionSE
```
    オーバーライド:
    クラス ConnectionManagerSupport の stopInternal
    例外:
    ExceptionSE
  - openConnection
```
protected void openConnection()
```
    次で指定:
    クラス ConnectionManagerSupport の openConnection
  - closeConnection
```
protected void closeConnection()
                        throws ExceptionSE
```
    次で指定:
    クラス ConnectionManagerSupport の closeConnection
    例外:
    ExceptionSE
  - isConnected
```
protected boolean isConnected()
```
    次で指定:
    クラス ConnectionManagerSupport の isConnected

クラス WebSocketConnectionManager

フィールドサマリー

クラス org.springframework.web.socket.client.ConnectionManagerSupport から継承されたフィールド

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

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.socket.client.ConnectionManagerSupport から継承されたメソッド

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

コンストラクターの詳細

WebSocketConnectionManager

メソッドの詳細

decorateWebSocketHandler

setSubProtocols

getSubProtocols

setOrigin

getOrigin

setHeaders

getHeaders

startInternal

stopInternal

openConnection

closeConnection

isConnected