StompSubProtocolHandler (Spring Framework API)

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

実装されたすべてのインターフェース:
Aware, ApplicationEventPublisherAware, SubProtocolHandler
```
public class StompSubProtocolHandler
extends ObjectSE
implements SubProtocolHandler, ApplicationEventPublisherAware
```
STOMP 仕様のバージョン 1.0, 1.1,, 1.2 をサポートする STOMP 用の SubProtocolHandler。
導入:
4.0
作成者:
Rossen Stoyanchev, Andy Wilkinson

ネストされたクラスのサマリー
ネストされたクラス
修飾子と型クラスと説明
static interface StompSubProtocolHandler.Stats
セッションカウンターへのアクセスの契約。

ネストされたクラス
修飾子と型	クラスと説明
`static interface`	`StompSubProtocolHandler.Stats` セッションカウンターへのアクセスの契約。

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`CONNECTED_USER_HEADER` WebSocket セッションで認証されたユーザーの名前を示す、CONNECTED フレームに設定されたヘッダーの名前。
`static int`	`MINIMUM_WEBSOCKET_MESSAGE_SIZE` このハンドラーは、複数の WebSocket メッセージに分割された大きな STOMP メッセージの組み立てをサポートし、STOMP クライアント（stomp.js など）は実際に 16K 境界で大きな STOMP メッセージを分割します。

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
StompSubProtocolHandler()

コンストラクター
コンストラクターと説明
`StompSubProtocolHandler()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)` `WebSocketSession` が終了した後に呼び出されます。
`void`	`afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)` `WebSocketSession` が開始した後に呼び出されます。
`StompSubProtocolErrorHandler`	`getErrorHandler()` 設定されたエラーハンドラーを返します。
`MessageHeaderInitializer`	`getHeaderInitializer()` 設定済みのヘッダー初期化子を返します。
`int`	`getMessageSizeLimit()` 設定されたメッセージバッファサイズの制限をバイト単位で取得します。
`StompSubProtocolHandler.Stats`	`getStats()` 内部状態とカウンターを含む構造化オブジェクトを返します。
`StringSE`	`getStatsInfo()` 内部状態とカウンタを記述する文字列を返します。
`ListSE<StringSE>`	`getSupportedProtocols()` このハンドラーでサポートされているサブプロトコルのリストを返します（非 `null`）。
`void`	`handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)` クライアントからの受信 WebSocket メッセージを処理します。
`void`	`handleMessageToClient(WebSocketSession session, Message<?> message)` WebSocket クライアントに戻る STOMP メッセージを処理します。
`StringSE`	`resolveSessionId(Message<?> message)` 指定されたメッセージからセッション ID を解決するか、`null` を返します。
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)` このオブジェクトが実行される ApplicationEventPublisher を設定します。
`void`	`setDecoder(StompDecoder decoder)` STOMP フレームをデコードするために `StompDecoder` を構成します。
`void`	`setEncoder(StompEncoder encoder)` STOMP フレームのエンコード用に `StompEncoder` を構成します。
`void`	`setErrorHandler(StompSubProtocolErrorHandler errorHandler)` クライアントに送信されるエラーメッセージのハンドラーを構成します。これにより、エラーメッセージをカスタマイズしたり、送信されないようにすることができます。
`void`	`setHeaderInitializer(MessageHeaderInitializer headerInitializer)` `MessageHeaderInitializer` を構成して、デコードされた STOMP フレームから作成されたすべてのメッセージと、クライアントの受信チャネルに送信された他のメッセージのヘッダーに適用します。
`void`	`setMessageSizeLimit(int messageSizeLimit)` 受信 STOMP メッセージに許可される最大サイズを構成します。
`protected StompHeaderAccessor`	`toMutableAccessor(StompHeaderAccessor headerAccessor, Message<?> message)`
`StringSE`	`toString()`

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

- フィールドの詳細
  - MINIMUM_WEBSOCKET_MESSAGE_SIZE
```
public static final int MINIMUM_WEBSOCKET_MESSAGE_SIZE
```
    このハンドラーは、複数の WebSocket メッセージに分割された大きな STOMP メッセージの組み立てをサポートし、STOMP クライアント（stomp.js など）は実際に 16K 境界で大きな STOMP メッセージを分割します。そのため、WebSocket サーバーの入力メッセージバッファーサイズは、少なくとも 16K に加えて、SockJS フレーミング用に少し余分に必要です。
    関連事項:
    定数フィールド値
  - CONNECTED_USER_HEADER
```
public static final StringSE CONNECTED_USER_HEADER
```
    WebSocket セッションで認証されたユーザーの名前を示す、CONNECTED フレームに設定されたヘッダーの名前。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - StompSubProtocolHandler
```
public StompSubProtocolHandler()
```
- メソッドの詳細
  - setErrorHandler
```
public void setErrorHandler(StompSubProtocolErrorHandler errorHandler)
```
    クライアントに送信されるエラーメッセージのハンドラーを構成します。これにより、エラーメッセージをカスタマイズしたり、送信されないようにすることができます。
    デフォルトでは、これは設定されていません。その場合、エラーを反映するメッセージヘッダーとともに ERROR フレームが送信されます。
    パラメーター:
    errorHandler - エラーハンドラー
  - getErrorHandler
```
@Nullable
public StompSubProtocolErrorHandler getErrorHandler()
```
    設定されたエラーハンドラーを返します。
  - setMessageSizeLimit
```
public void setMessageSizeLimit(int messageSizeLimit)
```
    受信 STOMP メッセージに許可される最大サイズを構成します。STOMP メッセージは複数の WebSocket メッセージで受信できるため、バッファリングが必要になる場合があり、許可される最大メッセージサイズを知る必要があります。
    デフォルトでは、このプロパティは 64K に設定されています。
    導入:
    4.0.3
  - getMessageSizeLimit
```
public int getMessageSizeLimit()
```
    設定されたメッセージバッファサイズの制限をバイト単位で取得します。
    導入:
    4.0.3
  - setEncoder
```
public void setEncoder(StompEncoder encoder)
```
    STOMP フレームのエンコード用に StompEncoder を構成します。
    導入:
    4.3.5
  - setDecoder
```
public void setDecoder(StompDecoder decoder)
```
    STOMP フレームをデコードするために StompDecoder を構成します。
    導入:
    4.3.5
  - setHeaderInitializer
```
public void setHeaderInitializer(@Nullable
                                 MessageHeaderInitializer headerInitializer)
```
    MessageHeaderInitializer を構成して、デコードされた STOMP フレームから作成されたすべてのメッセージと、クライアントの受信チャネルに送信された他のメッセージのヘッダーに適用します。
    デフォルトでは、このプロパティは設定されていません。
  - getHeaderInitializer
```
@Nullable
public MessageHeaderInitializer getHeaderInitializer()
```
    設定済みのヘッダー初期化子を返します。
  - getSupportedProtocols
```
public ListSE<StringSE> getSupportedProtocols()
```
    インターフェースからコピーされた説明: SubProtocolHandler
    このハンドラーでサポートされているサブプロトコルのリストを返します（非 null）。
    次で指定:
    インターフェース SubProtocolHandler の getSupportedProtocols
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    インターフェースからコピーされた説明: ApplicationEventPublisherAware
    このオブジェクトが実行される ApplicationEventPublisher を設定します。
    通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware の setApplicationContext の前に呼び出されます。
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
    パラメーター:
    applicationEventPublisher - このオブジェクトによって使用されるイベント発行元
  - getStatsInfo
```
public StringSE getStatsInfo()
```
    内部状態とカウンタを説明する文字列を返します。事実上、getStats() 上の toString()。
  - getStats
```
public StompSubProtocolHandler.Stats getStats()
```
    内部状態とカウンターを含む構造化オブジェクトを返します。
    導入:
    5.2
  - handleMessageFromClient
```
public void handleMessageFromClient(WebSocketSession session,
                                    WebSocketMessage<?> webSocketMessage,
                                    MessageChannel outputChannel)
```
    クライアントからの受信 WebSocket メッセージを処理します。
    次で指定:
    インターフェース SubProtocolHandler の handleMessageFromClient
    パラメーター:
    session - クライアントセッション
    webSocketMessage - クライアントメッセージ
    outputChannel - メッセージを送信する出力チャネル
  - handleMessageToClient
```
public void handleMessageToClient(WebSocketSession session,
                                  Message<?> message)
```
    WebSocket クライアントに戻る STOMP メッセージを処理します。
    次で指定:
    インターフェース SubProtocolHandler の handleMessageToClient
    パラメーター:
    session - クライアントセッション
    message - クライアントメッセージ
  - toMutableAccessor
```
protected StompHeaderAccessor toMutableAccessor(StompHeaderAccessor headerAccessor,
                                                Message<?> message)
```
  - resolveSessionId
```
@Nullable
public StringSE resolveSessionId(Message<?> message)
```
    インターフェースからコピーされた説明: SubProtocolHandler
    指定されたメッセージからセッション ID を解決するか、null を返します。
    次で指定:
    インターフェース SubProtocolHandler の resolveSessionId
    パラメーター:
    message - セッション ID を解決するメッセージ
  - afterSessionStarted
```
public void afterSessionStarted(WebSocketSession session,
                                MessageChannel outputChannel)
```
    インターフェースからコピーされた説明: SubProtocolHandler
    WebSocketSession が開始した後に呼び出されます。
    次で指定:
    インターフェース SubProtocolHandler の afterSessionStarted
    パラメーター:
    session - クライアントセッション
    outputChannel - チャンネル
  - afterSessionEnded
```
public void afterSessionEnded(WebSocketSession session,
                              CloseStatus closeStatus,
                              MessageChannel outputChannel)
```
    インターフェースからコピーされた説明: SubProtocolHandler
    WebSocketSession が終了した後に呼び出されます。
    次で指定:
    インターフェース SubProtocolHandler の afterSessionEnded
    パラメーター:
    session - クライアントセッション
    closeStatus - セッションが閉じられた理由
    outputChannel - チャンネル
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス StompSubProtocolHandler

ネストされたクラスのサマリー

フィールドサマリー

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

メソッドのサマリー

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

フィールドの詳細

MINIMUM_WEBSOCKET_MESSAGE_SIZE

CONNECTED_USER_HEADER

コンストラクターの詳細

StompSubProtocolHandler

メソッドの詳細

setErrorHandler

getErrorHandler

setMessageSizeLimit

getMessageSizeLimit

setEncoder

setDecoder

setHeaderInitializer

getHeaderInitializer

getSupportedProtocols

setApplicationEventPublisher

getStatsInfo

getStats

handleMessageFromClient

handleMessageToClient

toMutableAccessor

resolveSessionId

afterSessionStarted

afterSessionEnded

toString