SubProtocolWebSocketHandler (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

実装されているすべてのインターフェース:
Lifecycle, Phased, SmartLifecycle, MessageHandler, SubProtocolCapable, WebSocketHandler
```
public class SubProtocolWebSocketHandler
extends ObjectSE
implements WebSocketHandler, SubProtocolCapable, MessageHandler, SmartLifecycle
```
サブプロトコルハンドラーが WebSocket クライアントからアプリケーションにメッセージを送信できる MessageChannel とともに、受信 WebSocket メッセージを SubProtocolHandler に委譲する WebSocketHandler の実装。
また、Message に関連付けられた WebSocket セッションを見つけ、それをメッセージとともにサブプロトコルハンドラーに渡して、アプリケーションからクライアントにメッセージを送り返す MessageHandler の実装。
導入:
4.0
作成者:
Rossen Stoyanchev, Andy Wilkinson, Artem Bilan

コンストラクターの概要

コンストラクター
コンストラクターと説明
`SubProtocolWebSocketHandler(MessageChannel clientInboundChannel, SubscribableChannel clientOutboundChannel)` 指定された受信および送信チャネル用に新しい `SubProtocolWebSocketHandler` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addProtocolHandler(SubProtocolHandler handler)` サブプロトコルハンドラーを登録します。
`void`	`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)` WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。
`void`	`afterConnectionEstablished(WebSocketSession session)` WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。
`protected SubProtocolHandler`	`findProtocolHandler(WebSocketSession session)`
`SubProtocolHandler`	`getDefaultProtocolHandler()` 使用するデフォルトのサブプロトコルハンドラーを返します。
`int`	`getPhase()` このオブジェクトのフェーズ値を返します。
`MapSE<StringSE, SubProtocolHandler>`	`getProtocolHandlerMap()` プロトコル名をキーとするサブプロトコルを返します。
`ListSE<SubProtocolHandler>`	`getProtocolHandlers()`
`int`	`getSendBufferSizeLimit()` バッファサイズの制限（バイト数）を返します。
`int`	`getSendTimeLimit()` 送信時間制限（ミリ秒）を返します。
`StringSE`	`getStatsInfo()` 内部状態とカウンタを記述する文字列を返します。
`ListSE<StringSE>`	`getSubProtocols()` サポートされているすべてのプロトコルを返します。
`void`	`handleMessage(Message<?> message)` WebSocket クライアントへの発信 Spring メッセージを処理します。
`void`	`handleMessage(WebSocketSession session, WebSocketMessage<?> message)` WebSocket クライアントからの受信メッセージを処理します。
`void`	`handleTransportError(WebSocketSession session, ThrowableSE exception)` 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。
`boolean`	`isAutoStartup()` `true` が含まれる `ApplicationContext` がリフレッシュされるときに、この `Lifecycle` コンポーネントがコンテナーによって自動的に開始される場合、`true` を返します。
`boolean`	`isRunning()` このコンポーネントが現在実行されているかどうかを確認します。
`void`	`setDefaultProtocolHandler(SubProtocolHandler defaultProtocolHandler)` クライアントがサブプロトコルをリクエストしなかったときに使用するように `SubProtocolHandler` を設定します。
`void`	`setProtocolHandlers(ListSE<SubProtocolHandler> protocolHandlers)` WebSocket ハンドシェイクリクエストでクライアントがリクエストしたサブプロトコルに応じて、使用する 1 つ以上のハンドラーを構成します。
`void`	`setSendBufferSizeLimit(int sendBufferSizeLimit)` バッファサイズの制限（バイト数）を指定します。
`void`	`setSendTimeLimit(int sendTimeLimit)` 送信時間制限（ミリ秒）を指定します。
`void`	`start()` このコンポーネントを起動します。
`void`	`stop()` このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。
`void`	`stop(RunnableSE callback)` Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。
`boolean`	`supportsPartialMessages()` WebSocketHandler が部分的なメッセージを処理するかどうか。
`StringSE`	`toString()`

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

- コンストラクターの詳細
  - SubProtocolWebSocketHandler
```
public SubProtocolWebSocketHandler(MessageChannel clientInboundChannel,
                                   SubscribableChannel clientOutboundChannel)
```
    指定された受信および送信チャネル用に新しい SubProtocolWebSocketHandler を作成します。
    パラメーター:
    clientInboundChannel - 受信 MessageChannel
    clientOutboundChannel - 送信 MessageChannel
- メソッドの詳細
  - setProtocolHandlers
```
public void setProtocolHandlers(ListSE<SubProtocolHandler> protocolHandlers)
```
    WebSocket ハンドシェイクリクエストでクライアントがリクエストしたサブプロトコルに応じて、使用する 1 つ以上のハンドラーを構成します。
    パラメーター:
    protocolHandlers - 使用するサブプロトコルハンドラー
  - getProtocolHandlers
```
public ListSE<SubProtocolHandler> getProtocolHandlers()
```
  - addProtocolHandler
```
public void addProtocolHandler(SubProtocolHandler handler)
```
    サブプロトコルハンドラーを登録します。
  - getProtocolHandlerMap
```
public MapSE<StringSE,SubProtocolHandler> getProtocolHandlerMap()
```
    プロトコル名をキーとするサブプロトコルを返します。
  - setDefaultProtocolHandler
```
public void setDefaultProtocolHandler(@Nullable
                                      SubProtocolHandler defaultProtocolHandler)
```
    クライアントがサブプロトコルをリクエストしなかったときに使用するように SubProtocolHandler を設定します。
    パラメーター:
    defaultProtocolHandler - デフォルトのハンドラー
  - getDefaultProtocolHandler
```
@Nullable
public SubProtocolHandler getDefaultProtocolHandler()
```
    使用するデフォルトのサブプロトコルハンドラーを返します。
  - getSubProtocols
```
public ListSE<StringSE> getSubProtocols()
```
    サポートされているすべてのプロトコルを返します。
    次で指定:
    インターフェース SubProtocolCapable の getSubProtocols
  - setSendTimeLimit
```
public void setSendTimeLimit(int sendTimeLimit)
```
    送信時間制限（ミリ秒）を指定します。
    関連事項:
    ConcurrentWebSocketSessionDecorator
  - getSendTimeLimit
```
public int getSendTimeLimit()
```
    送信時間制限（ミリ秒）を返します。
  - setSendBufferSizeLimit
```
public void setSendBufferSizeLimit(int sendBufferSizeLimit)
```
    バッファサイズの制限（バイト数）を指定します。
    関連事項:
    ConcurrentWebSocketSessionDecorator
  - getSendBufferSizeLimit
```
public int getSendBufferSizeLimit()
```
    バッファサイズの制限（バイト数）を返します。
  - getStatsInfo
```
public StringSE getStatsInfo()
```
    内部状態とカウンタを記述する文字列を返します。
  - isAutoStartup
```
public boolean isAutoStartup()
```
    インターフェースからコピーされた説明: SmartLifecycle
    true が含まれる ApplicationContext がリフレッシュされるときに、この Lifecycle コンポーネントがコンテナーによって自動的に開始される場合、true を返します。
    false の値は、プレーン Lifecycle 実装に類似した、明示的な Lifecycle.start() 呼び出しを介してコンポーネントが開始されることを意図していることを示します。
    次で指定:
    インターフェース SmartLifecycle の isAutoStartup
    関連事項:
    Lifecycle.start(), Phased.getPhase(), LifecycleProcessor.onRefresh(), ConfigurableApplicationContext.refresh()
  - getPhase
```
public int getPhase()
```
    インターフェースからコピーされた説明: Phased
    このオブジェクトのフェーズ値を返します。
    次で指定:
    インターフェース Phased の getPhase
  - start
```
public final void start()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントを起動します。
    コンポーネントがすでに実行されている場合は、例外をスローしないでください。
    コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。
    次で指定:
    インターフェース Lifecycle の start
    関連事項:
    SmartLifecycle.isAutoStartup()
  - stop
```
public final void stop()
```
    インターフェースからコピーされた説明: Lifecycle
    このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。
    この停止通知が破棄の前に来るとは限らないことに注意してください。通常のシャットダウンでは、Lifecycle Bean は一般的な破棄コールバックが伝達される前に、まず停止通知を受け取ります。ただし、コンテキストの有効期間中のホットリフレッシュ時、またはリフレッシュ試行が中止されたときは、destroy メソッドのみが呼び出されます。
    コンポーネントがまだ開始されていない場合は、例外をスローしないでください。
    コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。
    次で指定:
    インターフェース Lifecycle の stop
    関連事項:
    SmartLifecycle.stop(Runnable), DisposableBean.destroy()
  - stop
```
public final void stop(RunnableSE callback)
```
    インターフェースからコピーされた説明: SmartLifecycle
    Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。
    提供されたコールバックは、LifecycleProcessor によって使用され、共通のシャットダウン順序値を持つすべてのコンポーネントの順序付けられた、潜在的に同時のシャットダウンをサポートします。コールバックは、SmartLifecycle コンポーネントが実際に停止した後に実行する必要があります。
    LifecycleProcessor は、stop メソッドのこのバリアントのみを呼び出します。つまり、SmartLifecycle 実装では、このメソッドの実装内に明示的に委譲されない限り、Lifecycle.stop() は呼び出されません。
    次で指定:
    インターフェース SmartLifecycle の stop
    関連事項:
    Lifecycle.stop(), Phased.getPhase()
  - isRunning
```
public final boolean isRunning()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントが現在実行されているかどうかを確認します。
    コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。
    次で指定:
    インターフェース Lifecycle の isRunning
    戻り値:
    コンポーネントが現在実行中かどうか
  - afterConnectionEstablished
```
public void afterConnectionEstablished(WebSocketSession session)
                                throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。
    次で指定:
    インターフェース WebSocketHandler の afterConnectionEstablished
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - handleMessage
```
public void handleMessage(WebSocketSession session,
                          WebSocketMessage<?> message)
                   throws ExceptionSE
```
    WebSocket クライアントからの受信メッセージを処理します。
    次で指定:
    インターフェース WebSocketHandler の handleMessage
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - handleMessage
```
public void handleMessage(Message<?> message)
                   throws MessagingException
```
    WebSocket クライアントへの発信 Spring メッセージを処理します。
    次で指定:
    インターフェース MessageHandler の handleMessage
    パラメーター:
    message - 処理するメッセージ
    例外:
    MessagingException
  - handleTransportError
```
public void handleTransportError(WebSocketSession session,
                                 ThrowableSE exception)
                          throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    基礎となる WebSocket メッセージトランスポートからのエラーを処理します。
    次で指定:
    インターフェース WebSocketHandler の handleTransportError
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - afterConnectionClosed
```
public void afterConnectionClosed(WebSocketSession session,
                                  CloseStatus closeStatus)
                           throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocket 接続がどちらかの側で閉じられた後、または転送エラーが発生した後に呼び出されます。セッションは技術的にはまだ開いている可能性がありますが、基盤となる実装によっては、この時点でメッセージを送信することはお勧めできません。おそらく成功しません。
    次で指定:
    インターフェース WebSocketHandler の afterConnectionClosed
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - supportsPartialMessages
```
public boolean supportsPartialMessages()
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocketHandler が部分的なメッセージを処理するかどうか。このフラグが true に設定され、基礎となる WebSocket サーバーが部分メッセージをサポートする場合、大きな WebSocket メッセージまたは不明なサイズのメッセージが分割され、WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage) への複数の呼び出しで受信される可能性があります。フラグ WebSocketMessage.isLast() は、メッセージが部分的であるかどうか、およびメッセージが最後の部分であるかどうかを示します。
    次で指定:
    インターフェース WebSocketHandler の supportsPartialMessages
  - findProtocolHandler
```
protected final SubProtocolHandler findProtocolHandler(WebSocketSession session)
```
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス SubProtocolWebSocketHandler

コンストラクターの概要

メソッドのサマリー

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

コンストラクターの詳細

SubProtocolWebSocketHandler

メソッドの詳細

setProtocolHandlers

getProtocolHandlers

addProtocolHandler

getProtocolHandlerMap

setDefaultProtocolHandler

getDefaultProtocolHandler

getSubProtocols

setSendTimeLimit

getSendTimeLimit

setSendBufferSizeLimit

getSendBufferSizeLimit

getStatsInfo

isAutoStartup

getPhase

start

stop

stop

isRunning

afterConnectionEstablished

handleMessage

handleMessage

handleTransportError

afterConnectionClosed

supportsPartialMessages

findProtocolHandler

toString