クラス ServerWebSocketContainer

方法の詳細

• 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...)

• setAllowedOriginPatterns

  public ServerWebSocketContainer setAllowedOriginPatterns(StringSE... originPatterns)

  ブラウザーからのクロスオリジンリクエストを許可するオリジンパターンを指定します。

  パラメーター:

  originPatterns - 許可する起源パターン。

  戻り値:

  現在の ServerWebSocketContainer

  導入:

  7.0.5

  関連事項:

  • WebSocketHandlerRegistration.setAllowedOriginPatterns(String...)

• withSockJs

  public ServerWebSocketContainer withSockJs(ServerWebSocketContainer.SockJsServiceOptions... sockJsServiceOptions)

• setSockJsServiceOptions

  public void setSockJsServiceOptions(ServerWebSocketContainer.SockJsServiceOptions sockJsServiceOptions)

• setSockJsTaskScheduler

  public void setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)

  SockJS フォールバックサービス用に TaskScheduler を構成します。これは、実行時に Websocket エンドポイント（このサーバーコンテナー）が登録されている場合のデフォルトの SockJS サービススケジューラの代替手段です。

  パラメーター:

  sockJsTaskScheduler - SockJS フォールバックサービス用の TaskScheduler。

  導入:

  5.5.1

• getSockJsTaskScheduler

  public @Nullable TaskScheduler getSockJsTaskScheduler()

• 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