クラス SimpMessageHeaderAccessor
java.lang.ObjectSE
org.springframework.messaging.support.MessageHeaderAccessor
org.springframework.messaging.support.NativeMessageHeaderAccessor
org.springframework.messaging.simp.SimpMessageHeaderAccessor
- 既知の直属サブクラス
StompHeaderAccessor
基本的なメッセージングパターンをサポートする単純なメッセージングプロトコルでメッセージヘッダーを操作するための基本クラスです。宛先、メッセージ型 (パブリッシュ、サブスクライブなど)、セッション ID など、プロトコル間で共通する特定の値への均一なアクセスを提供します。
このクラスの静的ファクトリメソッドの 1 つを使用してから、getter および setter を呼び出し、必要に応じて最後に MessageHeaderAccessor.toMap() を呼び出して更新されたヘッダーを取得します。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSE送信者がエラーを無視することをブローカーに示すヘッダー。static final StringSEstatic final StringSEクライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。static final StringSEstatic final StringSEstatic final StringSEstatic final StringSEクラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたフィールド
NATIVE_HEADERSクラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド
DEFAULT_CHARSETコンストラクターの概要
コンストラクター修飾子コンストラクター説明protectedSimpMessageHeaderAccessor(Message<?> message) 既存のメッセージヘッダーにアクセスして変更するためのコンストラクター。protectedSimpMessageHeaderAccessor(SimpMessageType messageType, MapSE<StringSE, ListSE<StringSE>> externalSourceHeaders) 新しいメッセージヘッダーを作成するためのコンストラクター。メソッドのサマリー
修飾子と型メソッド説明static SimpMessageHeaderAccessorcreate()SimpMessageTypeMESSAGEでインスタンスを作成します。static SimpMessageHeaderAccessorcreate(SimpMessageType messageType) 指定されたSimpMessageTypeでインスタンスを作成します。protected MessageHeaderAccessorcreateAccessor(Message<?> message) 指定されたメッセージの「ネストされた」アクセサーを構築します。static StringSEgetDestination(MapSE<StringSE, ObjectSE> headers) getDetailedLogMessage(ObjectSE payload) ロギングの目的で、より詳細なメッセージを返します。static long[]getHeartbeat(MapSE<StringSE, ObjectSE> headers) static SimpMessageTypegetMessageType(MapSE<StringSE, ObjectSE> headers) 現在のセッションに関連付けられている属性を返します。getSessionAttributes(MapSE<StringSE, ObjectSE> headers) 現在のセッションの ID を返します。static StringSEgetSessionId(MapSE<StringSE, ObjectSE> headers) getShortLogMessage(ObjectSE payload) ロギングのために簡潔なメッセージを返します。static StringSEgetSubscriptionId(MapSE<StringSE, ObjectSE> headers) getUser()現在のセッションに関連付けられているユーザーを返します。static PrincipalSEvoidsetDestination(StringSE destination) voidsetMessageTypeIfNotSet(SimpMessageType messageType) voidsetSessionAttributes(MapSE<StringSE, ObjectSE> attributes) セッション属性ヘッダーにアクセスするための静的な代替手段。voidsetSessionId(StringSE sessionId) voidsetSubscriptionId(StringSE subscriptionId) voidsetUser(PrincipalSE principal) voidsetUserChangeCallback(ConsumerSE<PrincipalSE> callback) setUser(Principal)が呼び出されたときに呼び出されるコールバックを提供します。static SimpMessageHeaderAccessorメッセージのヘッダーをコピーしてインスタンスを作成します。クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたメソッド
addNativeHeader, addNativeHeaders, containsNativeHeader, copyHeaders, copyHeadersIfAbsent, getFirstNativeHeader, getFirstNativeHeader, getNativeHeader, getNativeHeaders, removeNativeHeader, setImmutable, setNativeHeader, setNativeHeaderValues, toNativeHeaderMapクラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド
fromMap, fromMessageHeaders, getAccessor, getAccessor, getAccessor, getContentType, getDetailedPayloadLogMessage, getErrorChannel, getHeader, getId, getMessageHeaders, getMutableAccessor, getReplyChannel, getShortPayloadLogMessage, getTimestamp, isModified, isMutable, isReadableContentType, isReadOnly, removeHeader, removeHeaders, setContentType, setErrorChannel, setErrorChannelName, setHeader, setHeaderIfAbsent, setLeaveMutable, setModified, setReplyChannel, setReplyChannelName, toMap, toMessageHeaders, toString, verifyType
フィールドの詳細
DESTINATION_HEADER
- 関連事項:
MESSAGE_TYPE_HEADER
- 関連事項:
SESSION_ID_HEADER
- 関連事項:
SESSION_ATTRIBUTES
- 関連事項:
SUBSCRIPTION_ID_HEADER
- 関連事項:
USER_HEADER
- 関連事項:
CONNECT_MESSAGE_HEADER
- 関連事項:
DISCONNECT_MESSAGE_HEADER
- 関連事項:
HEART_BEAT_HEADER
- 関連事項:
ORIGINAL_DESTINATION
クライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。- 関連事項:
IGNORE_ERROR
送信者がエラーを無視することをブローカーに示すヘッダー。ヘッダーは単に存在または不在をチェックされます。- 関連事項:
コンストラクターの詳細
SimpMessageHeaderAccessor
protected SimpMessageHeaderAccessor(SimpMessageType messageType, @Nullable MapSE<StringSE, ListSE<StringSE>> externalSourceHeaders) 新しいメッセージヘッダーを作成するためのコンストラクター。このコンストラクターは保護されています。このクラスとサブクラスのファクトリメソッドを参照してください。
SimpMessageHeaderAccessor
既存のメッセージヘッダーにアクセスして変更するためのコンストラクター。このコンストラクターは保護されています。このクラスとサブクラスのファクトリメソッドを参照してください。
メソッドの詳細
createAccessor
クラスからコピーされた説明:MessageHeaderAccessor指定されたメッセージの「ネストされた」アクセサーを構築します。- オーバーライド:
- クラス
MessageHeaderAccessorのcreateAccessor - パラメーター:
message- 新しいアクセサーを構築するためのメッセージ- 戻り値:
- ネストされたアクセサー (通常は特定のサブクラス)
setMessageTypeIfNotSet
getMessageType
setDestination
getDestination
setSubscriptionId
getSubscriptionId
setSessionId
getSessionId
現在のセッションの ID を返します。setSessionAttributes
セッション属性ヘッダーにアクセスするための静的な代替手段。getSessionAttributes
現在のセッションに関連付けられている属性を返します。setUser
getUser
現在のセッションに関連付けられているユーザーを返します。setUserChangeCallback
setUser(Principal)が呼び出されたときに呼び出されるコールバックを提供します。これは、インターセプターを介したトークンベースの認証を検出するために、受信・チャネルで内部的に使用されます。- パラメーター:
callback- 呼び出すコールバック- 導入:
- 5.1.9
getShortLogMessage
クラスからコピーされた説明:MessageHeaderAccessorロギングのために簡潔なメッセージを返します。- オーバーライド:
- クラス
MessageHeaderAccessorのgetShortLogMessage - パラメーター:
payload- ヘッダーに対応するペイロード。- 戻り値:
- メッセージ
getDetailedLogMessage
クラスからコピーされた説明:MessageHeaderAccessorロギングの目的で、より詳細なメッセージを返します。- オーバーライド:
- クラス
MessageHeaderAccessorのgetDetailedLogMessage - パラメーター:
payload- ヘッダーに対応するペイロード。- 戻り値:
- メッセージ
create
SimpMessageTypeMESSAGEでインスタンスを作成します。create
指定されたSimpMessageTypeでインスタンスを作成します。wrap
メッセージのヘッダーをコピーしてインスタンスを作成します。getMessageType
getDestination
getSubscriptionId
getSessionId
getSessionAttributes
getUser
getHeartbeat