クラス StompHeaderAccessor
java.lang.ObjectSE
org.springframework.messaging.support.MessageHeaderAccessor
org.springframework.messaging.support.NativeMessageHeaderAccessor
org.springframework.messaging.simp.SimpMessageHeaderAccessor
org.springframework.messaging.simp.stomp.StompHeaderAccessor
デコードされた STOMP フレームから
Message を作成するとき、または Message を STOMP フレームにエンコードするときに使用する MessageHeaderAccessor。STOMP フレームコンテンツから作成される場合、実際の STOMP ヘッダーは親クラス NativeMessageHeaderAccessor によって管理されるネイティブヘッダーサブマップに格納されますが、親クラス SimpMessageHeaderAccessor は共通処理ヘッダーを管理します。これらのヘッダーの一部は STOMP ヘッダーに基づいています (宛先、コンテンツ型など)。
このクラスのインスタンスは、既存の Message をラップすることでも作成できます。そのメッセージは、より一般的な SimpMessageHeaderAccessor で作成された可能性があり、その場合、STOMP ヘッダーは共通の処理ヘッダーから作成されます。この場合、メッセージを送信する場合、メッセージをクライアントに送信するかメッセージブローカーに送信するかに応じて、updateStompCommandAsClientMessage() または updateStompCommandAsServerMessage() を呼び出す必要もあります。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEクラス SimpMessageHeaderAccessor から継承されたフィールド
CONNECT_MESSAGE_HEADER, DESTINATION_HEADER, DISCONNECT_MESSAGE_HEADER, HEART_BEAT_HEADER, IGNORE_ERROR, MESSAGE_TYPE_HEADER, ORIGINAL_DESTINATION, SESSION_ATTRIBUTES, SESSION_ID_HEADER, SUBSCRIPTION_ID_HEADER, USER_HEADERクラス NativeMessageHeaderAccessor から継承されたフィールド
NATIVE_HEADERSクラス MessageHeaderAccessor から継承されたフィールド
DEFAULT_CHARSET方法の概要
修飾子と型メソッド説明static StompHeaderAccessorcreate(StompCommand command) 指定された STOMP コマンドのインスタンスを作成します。static StompHeaderAccessor指定された STOMP コマンドとヘッダーのインスタンスを作成します。protected MessageHeaderAccessorcreateAccessor(Message<?> message) 指定されたメッセージの「ネストされた」アクセサーを構築します。static StompHeaderAccessorハートビートのヘッダーを作成します。getAck()STOMP コマンドを返すか、まだ設定されていない場合はnullを返します。static @Nullable StompCommandgetCommand(MapSE<StringSE, ObjectSE> headers) 指定されたヘッダーから STOMP コマンドを返します。設定されていない場合はnullを返します。getContentLength(MapSE<StringSE, ListSE<StringSE>> nativeHeaders) getDetailedLogMessage(@Nullable ObjectSE payload) ロギングの目的で、より詳細なメッセージを返します。long[]getHost()getLogin()getNack()サブクラスはこのメソッドを使用して、「ネイティブ」ヘッダーサブマップにアクセスできます。パスコードヘッダー値を返します。設定されていない場合はnullを返します。getPasscode(MapSE<StringSE, ObjectSE> headers) パスコードヘッダー値を返します。設定されていない場合はnullを返します。getShortLogMessage(ObjectSE payload) ロギングのために簡潔なメッセージを返します。booleanvoidsetAcceptVersion(StringSE acceptVersion) voidvoidsetContentLength(int contentLength) voidsetContentType(MimeType contentType) voidsetDestination(@Nullable StringSE destination) voidsetHeartbeat(long cx, long cy) voidvoidvoidsetMessage(@Nullable StringSE content) voidvoidvoidsetPasscode(@Nullable StringSE passcode) voidsetReceipt(@Nullable StringSE receiptId) voidsetReceiptId(@Nullable StringSE receiptId) voidsetSubscriptionId(@Nullable StringSE subscriptionId) voidsetVersion(@Nullable StringSE version) voidstatic StompHeaderAccessor指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。クラス SimpMessageHeaderAccessor から継承されたメソッド
create, create, getDestination, getDestination, getHeartbeat, getMessageType, getMessageType, getSessionAttributes, getSessionAttributes, getSessionId, getSessionId, getSubscriptionId, getSubscriptionId, getUser, getUser, setMessageTypeIfNotSet, setSessionAttributes, setSessionId, setUser, setUserChangeCallbackクラス NativeMessageHeaderAccessor から継承されたメソッド
addNativeHeader, addNativeHeaders, containsNativeHeader, copyHeaders, copyHeadersIfAbsent, getFirstNativeHeader, getFirstNativeHeader, getNativeHeader, removeNativeHeader, setImmutable, setNativeHeader, setNativeHeaderValues, toNativeHeaderMapクラス MessageHeaderAccessor から継承されたメソッド
fromMap, fromMessageHeaders, getAccessor, getAccessor, getAccessor, getContentType, getDetailedPayloadLogMessage, getErrorChannel, getHeader, getId, getMessageHeaders, getMutableAccessor, getReplyChannel, getShortPayloadLogMessage, getTimestamp, isModified, isMutable, isReadableContentType, isReadOnly, removeHeader, removeHeaders, setErrorChannel, setErrorChannelName, setHeader, setHeaderIfAbsent, setLeaveMutable, setModified, setReplyChannel, setReplyChannelName, toMap, toMessageHeaders, toString, verifyType
フィールドの詳細
STOMP_ID_HEADER
- 関連事項:
STOMP_HOST_HEADER
- 関連事項:
STOMP_ACCEPT_VERSION_HEADER
- 関連事項:
STOMP_MESSAGE_ID_HEADER
- 関連事項:
STOMP_RECEIPT_HEADER
- 関連事項:
STOMP_RECEIPT_ID_HEADER
- 関連事項:
STOMP_SUBSCRIPTION_HEADER
- 関連事項:
STOMP_VERSION_HEADER
- 関連事項:
STOMP_MESSAGE_HEADER
- 関連事項:
STOMP_ACK_HEADER
- 関連事項:
STOMP_NACK_HEADER
- 関連事項:
STOMP_LOGIN_HEADER
- 関連事項:
STOMP_PASSCODE_HEADER
- 関連事項:
STOMP_DESTINATION_HEADER
- 関連事項:
STOMP_CONTENT_TYPE_HEADER
- 関連事項:
STOMP_CONTENT_LENGTH_HEADER
- 関連事項:
STOMP_HEARTBEAT_HEADER
- 関連事項:
メソッドの詳細
createAccessor
クラスからコピーされた説明:MessageHeaderAccessor指定されたメッセージの「ネストされた」アクセサーを構築します。- オーバーライド:
- クラス
SimpMessageHeaderAccessorのcreateAccessor - パラメーター:
message- 新しいアクセサーを構築するためのメッセージ- 戻り値:
- ネストされたアクセサー (通常は特定のサブクラス)
getNativeHeaders
クラスからコピーされた説明:NativeMessageHeaderAccessorサブクラスはこのメソッドを使用して、「ネイティブ」ヘッダーサブマップにアクセスできます。- オーバーライド:
- クラス
NativeMessageHeaderAccessorのgetNativeHeaders
updateStompCommandAsClientMessage
updateStompCommandAsServerMessage
public void updateStompCommandAsServerMessage()getCommand
STOMP コマンドを返すか、まだ設定されていない場合はnullを返します。isHeartbeat
public boolean isHeartbeat()getHeartbeat
public long[] getHeartbeat()setAcceptVersion
getAcceptVersion
setHost
getHost
setDestination
- オーバーライド:
- クラス
SimpMessageHeaderAccessorのsetDestination
setContentType
- オーバーライド:
- クラス
MessageHeaderAccessorのsetContentType
setSubscriptionId
- オーバーライド:
- クラス
SimpMessageHeaderAccessorのsetSubscriptionId
getContentLength
setContentLength
public void setContentLength(int contentLength) setHeartbeat
public void setHeartbeat(long cx, long cy) setAck
getAck
setNack
getNack
setLogin
getLogin
setPasscode
getPasscode
setReceiptId
getReceiptId
setReceipt
getReceipt
getMessage
setMessage
getMessageId
setMessageId
getVersion
setVersion
getShortLogMessage
クラスからコピーされた説明:MessageHeaderAccessorロギングのために簡潔なメッセージを返します。- オーバーライド:
- クラス
SimpMessageHeaderAccessorのgetShortLogMessage - パラメーター:
payload- ヘッダーに対応するペイロード。- 戻り値:
- メッセージ
getDetailedLogMessage
クラスからコピーされた説明:MessageHeaderAccessorロギングの目的で、より詳細なメッセージを返します。- オーバーライド:
- クラス
SimpMessageHeaderAccessorのgetDetailedLogMessage - パラメーター:
payload- ヘッダーに対応するペイロード。- 戻り値:
- メッセージ
create
指定された STOMP コマンドのインスタンスを作成します。create
public static StompHeaderAccessor create(StompCommand command, MapSE<StringSE, ListSE<StringSE>> headers) 指定された STOMP コマンドとヘッダーのインスタンスを作成します。createForHeartbeat
ハートビートのヘッダーを作成します。STOMP ハートビートフレームにはヘッダーがありませんが、少なくとも処理の目的でセッション ID が必要です。wrap
指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。getCommand
指定されたヘッダーから STOMP コマンドを返します。設定されていない場合はnullを返します。getPasscode
getContentLength