ServerWebSocketContainer (Spring Integration API)

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

実装済みのインターフェース一覧:
DisposableBean, Lifecycle, Phased, SmartLifecycle, WebSocketConfigurer
```
public class ServerWebSocketContainer
extends IntegrationWebSocketContainer
implements WebSocketConfigurer, SmartLifecycle
```
server WebSocketHandler 登録用の IntegrationWebSocketContainer 実装。
paths の内部 IntegrationWebSocketContainer.IntegrationWebSocketHandler を WebSocketHandlerRegistry に登録します。
実際の登録は、このクラスの WebSocketConfigurer 実装を介した Spring Web-Socket インフラストラクチャに基づいています。
導入:
4.1
作成者:
Artem Bilan, Gary Russell

ネストされたクラスの概要
ネストされたクラス
修飾子と型クラスと説明
static class ServerWebSocketContainer.SockJsServiceOptions

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`ServerWebSocketContainer.SockJsServiceOptions`

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

コンストラクター概要
コンストラクター
コンストラクターと説明
ServerWebSocketContainer(StringSE... paths)

コンストラクター
コンストラクターと説明
`ServerWebSocketContainer(StringSE... paths)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`int`	`getPhase()`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`void`	`registerWebSocketHandlers(WebSocketHandlerRegistry registry)`
`ServerWebSocketContainer`	`setAllowedOrigins(StringSE... origins)` 許可された `Origin` ヘッダー値を構成します。
`void`	`setAutoStartup(boolean autoStartup)`
`ServerWebSocketContainer`	`setDecoratorFactories(WebSocketHandlerDecoratorFactory... factories)` WebSocket メッセージの処理に使用されるハンドラーを装飾するように 1 つ以上のファクトリを構成します。
`ServerWebSocketContainer`	`setHandshakeHandler(HandshakeHandler handshakeHandler)`
`ServerWebSocketContainer`	`setInterceptors(HandshakeInterceptor... interceptors)`
`void`	`setPhase(int phase)`
`void`	`setSockJsServiceOptions(ServerWebSocketContainer.SockJsServiceOptions sockJsServiceOptions)`
`void`	`start()`
`void`	`stop()`
`void`	`stop(RunnableSE callback)`
`ServerWebSocketContainer`	`withSockJs(ServerWebSocketContainer.SockJsServiceOptions... sockJsServiceOptions)`

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

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

- コンストラクターの詳細
  - ServerWebSocketContainer
```
public ServerWebSocketContainer(StringSE... paths)
```
- メソッドの詳細
  - setHandshakeHandler
```
public ServerWebSocketContainer setHandshakeHandler(HandshakeHandler handshakeHandler)
```
  - setInterceptors
```
public ServerWebSocketContainer setInterceptors(HandshakeInterceptor... interceptors)
```
  - setDecoratorFactories
```
public ServerWebSocketContainer setDecoratorFactories(WebSocketHandlerDecoratorFactory... factories)
```
    WebSocket メッセージの処理に使用されるハンドラーを装飾するように 1 つ以上のファクトリを構成します。これは、たとえば、対応する HTTP セッションの有効期限が切れたときに Spring Security が WebSocket セッションを強制的に閉じることを許可するなど、一部の高度な使用例で役立つ場合があります。
    パラメーター:
    factories - 使用する WebSocketHandlerDecoratorFactory 配列
    戻り値:
    現在の ServerWebSocketContainer
    導入:
    4.2
  - setAllowedOrigins
```
public ServerWebSocketContainer setAllowedOrigins(StringSE... origins)
```
    許可された Origin ヘッダー値を構成します。
    パラメーター:
    origins - 許可する起源。
    戻り値:
    現在の ServerWebSocketContainer
    導入:
    4.3
    関連事項:
    WebSocketHandlerRegistration.setAllowedOrigins(String...)
  - withSockJs
```
public ServerWebSocketContainer withSockJs(ServerWebSocketContainer.SockJsServiceOptions... sockJsServiceOptions)
```
  - setSockJsServiceOptions
```
public void setSockJsServiceOptions(ServerWebSocketContainer.SockJsServiceOptions sockJsServiceOptions)
```
  - registerWebSocketHandlers
```
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry)
```
    次で指定:
    インターフェース WebSocketConfigurer 内の registerWebSocketHandlers
  - setAutoStartup
```
public void setAutoStartup(boolean autoStartup)
```
  - setPhase
```
public void setPhase(int phase)
```
  - 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

クラス ServerWebSocketContainer

ネストされたクラスの概要

フィールド概要

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

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

コンストラクター概要

方法の概要

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

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

コンストラクターの詳細

ServerWebSocketContainer

メソッドの詳細

setHandshakeHandler

setInterceptors

setDecoratorFactories

setAllowedOrigins

withSockJs

setSockJsServiceOptions

registerWebSocketHandlers

setAutoStartup

setPhase

isAutoStartup

getPhase

isRunning

start

stop

stop