SimpMessageHeaderAccessor (Spring Framework API)

java.lang.ObjectSE
- org.springframework.messaging.support.MessageHeaderAccessor
- - org.springframework.messaging.support.NativeMessageHeaderAccessor
  - - org.springframework.messaging.simp.SimpMessageHeaderAccessor

既知の直属サブクラス
StompHeaderAccessor
```
public class SimpMessageHeaderAccessor
extends NativeMessageHeaderAccessor
```
基本的なメッセージングパターンをサポートする単純なメッセージングプロトコルでメッセージヘッダーを操作するための基本クラス。宛先、メッセージ型（パブリッシュ、サブスクライブなど）、セッション ID など、プロトコル全体で共通の特定の値への均一なアクセスを提供します。
このクラスの静的ファクトリメソッドの 1 つを使用してから getter および setter を呼び出し、必要に応じて MessageHeaderAccessor.toMap() を呼び出して更新されたヘッダーを取得します。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`CONNECT_MESSAGE_HEADER`
`static StringSE`	`DESTINATION_HEADER`
`static StringSE`	`DISCONNECT_MESSAGE_HEADER`
`static StringSE`	`HEART_BEAT_HEADER`
`static StringSE`	`IGNORE_ERROR` 送信者がエラーを無視することをブローカーに示すヘッダー。
`static StringSE`	`MESSAGE_TYPE_HEADER`
`static StringSE`	`ORIGINAL_DESTINATION` クライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。
`static StringSE`	`SESSION_ATTRIBUTES`
`static StringSE`	`SESSION_ID_HEADER`
`static StringSE`	`SUBSCRIPTION_ID_HEADER`
`static StringSE`	`USER_HEADER`

クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたフィールド
NATIVE_HEADERS

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド
DEFAULT_CHARSET

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

コンストラクター
修飾子	コンストラクターと説明
`protected`	`SimpMessageHeaderAccessor(Message<?> message)` 既存のメッセージヘッダーにアクセスして変更するためのコンストラクター。
`protected`	`SimpMessageHeaderAccessor(SimpMessageType messageType, MapSE<StringSE, ListSE<StringSE>> externalSourceHeaders)` 新しいメッセージヘッダーを作成するためのコンストラクター。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static SimpMessageHeaderAccessor`	`create()` `SimpMessageType` `MESSAGE` でインスタンスを作成します。
`static SimpMessageHeaderAccessor`	`create(SimpMessageType messageType)` 指定された `SimpMessageType` でインスタンスを作成します。
`protected MessageHeaderAccessor`	`createAccessor(Message<?> message)` 指定されたメッセージの「ネストされた」アクセサーを構築します。
`StringSE`	`getDestination()`
`static StringSE`	`getDestination(MapSE<StringSE, ObjectSE> headers)`
`StringSE`	`getDetailedLogMessage(ObjectSE payload)` ロギングの目的で、より詳細なメッセージを返します。
`static long[]`	`getHeartbeat(MapSE<StringSE, ObjectSE> headers)`
`SimpMessageType`	`getMessageType()`
`static SimpMessageType`	`getMessageType(MapSE<StringSE, ObjectSE> headers)`
`MapSE<StringSE, ObjectSE>`	`getSessionAttributes()` 現在のセッションに関連付けられている属性を返します。
`static MapSE<StringSE, ObjectSE>`	`getSessionAttributes(MapSE<StringSE, ObjectSE> headers)`
`StringSE`	`getSessionId()` 現在のセッションの ID を返します。
`static StringSE`	`getSessionId(MapSE<StringSE, ObjectSE> headers)`
`StringSE`	`getShortLogMessage(ObjectSE payload)` ロギングのために簡潔なメッセージを返します。
`StringSE`	`getSubscriptionId()`
`static StringSE`	`getSubscriptionId(MapSE<StringSE, ObjectSE> headers)`
`PrincipalSE`	`getUser()` 現在のセッションに関連付けられているユーザーを返します。
`static PrincipalSE`	`getUser(MapSE<StringSE, ObjectSE> headers)`
`void`	`setDestination(StringSE destination)`
`void`	`setMessageTypeIfNotSet(SimpMessageType messageType)`
`void`	`setSessionAttributes(MapSE<StringSE, ObjectSE> attributes)` セッション属性ヘッダーにアクセスするための静的な代替手段。
`void`	`setSessionId(StringSE sessionId)`
`void`	`setSubscriptionId(StringSE subscriptionId)`
`void`	`setUser(PrincipalSE principal)`
`void`	`setUserChangeCallback(ConsumerSE<PrincipalSE> callback)` `setUser(Principal)` が呼び出されたときに呼び出されるコールバックを提供します。
`static SimpMessageHeaderAccessor`	`wrap(Message<?> message)` 指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。

クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたメソッド
addNativeHeader, addNativeHeaders, containsNativeHeader, copyHeaders, copyHeadersIfAbsent, getFirstNativeHeader, getFirstNativeHeader, getNativeHeader, getNativeHeaders, removeNativeHeader, setImmutable, setNativeHeader, setNativeHeaderValues, toNativeHeaderMap

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド
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

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

- フィールドの詳細
  - DESTINATION_HEADER
```
public static final StringSE DESTINATION_HEADER
```
    関連事項:
    定数フィールド値
  - MESSAGE_TYPE_HEADER
```
public static final StringSE MESSAGE_TYPE_HEADER
```
    関連事項:
    定数フィールド値
  - SESSION_ID_HEADER
```
public static final StringSE SESSION_ID_HEADER
```
    関連事項:
    定数フィールド値
  - SESSION_ATTRIBUTES
```
public static final StringSE SESSION_ATTRIBUTES
```
    関連事項:
    定数フィールド値
  - SUBSCRIPTION_ID_HEADER
```
public static final StringSE SUBSCRIPTION_ID_HEADER
```
    関連事項:
    定数フィールド値
  - USER_HEADER
```
public static final StringSE USER_HEADER
```
    関連事項:
    定数フィールド値
  - CONNECT_MESSAGE_HEADER
```
public static final StringSE CONNECT_MESSAGE_HEADER
```
    関連事項:
    定数フィールド値
  - DISCONNECT_MESSAGE_HEADER
```
public static final StringSE DISCONNECT_MESSAGE_HEADER
```
    関連事項:
    定数フィールド値
  - HEART_BEAT_HEADER
```
public static final StringSE HEART_BEAT_HEADER
```
    関連事項:
    定数フィールド値
  - ORIGINAL_DESTINATION
```
public static final StringSE ORIGINAL_DESTINATION
```
    クライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。
    関連事項:
    定数フィールド値
  - IGNORE_ERROR
```
public static final StringSE IGNORE_ERROR
```
    送信者がエラーを無視することをブローカーに示すヘッダー。ヘッダーは単に存在または不在をチェックされます。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - SimpMessageHeaderAccessor
```
protected SimpMessageHeaderAccessor(SimpMessageType messageType,
                                    @Nullable
                                    MapSE<StringSE,ListSE<StringSE>> externalSourceHeaders)
```
    新しいメッセージヘッダーを作成するためのコンストラクター。このコンストラクターは保護されています。このクラスとサブクラスのファクトリメソッドを参照してください。
  - SimpMessageHeaderAccessor
```
protected SimpMessageHeaderAccessor(Message<?> message)
```
    既存のメッセージヘッダーにアクセスして変更するためのコンストラクター。このコンストラクターは保護されています。このクラスとサブクラスのファクトリメソッドを参照してください。
- メソッドの詳細
  - createAccessor
```
protected MessageHeaderAccessor createAccessor(Message<?> message)
```
    クラスからコピーされた説明: MessageHeaderAccessor
    指定されたメッセージの「ネストされた」アクセサーを構築します。
    オーバーライド:
    クラス MessageHeaderAccessor の createAccessor
    パラメーター:
    message - 新しいアクセサーを構築するためのメッセージ
    戻り値:
    ネストされたアクセサー (通常は特定のサブクラス)
  - setMessageTypeIfNotSet
```
public void setMessageTypeIfNotSet(SimpMessageType messageType)
```
  - getMessageType
```
@Nullable
public SimpMessageType getMessageType()
```
  - setDestination
```
public void setDestination(@Nullable
                           StringSE destination)
```
  - getDestination
```
@Nullable
public StringSE getDestination()
```
  - setSubscriptionId
```
public void setSubscriptionId(@Nullable
                              StringSE subscriptionId)
```
  - getSubscriptionId
```
@Nullable
public StringSE getSubscriptionId()
```
  - setSessionId
```
public void setSessionId(@Nullable
                         StringSE sessionId)
```
  - getSessionId
```
@Nullable
public StringSE getSessionId()
```
    現在のセッションの ID を返します。
  - setSessionAttributes
```
public void setSessionAttributes(@Nullable
                                 MapSE<StringSE,ObjectSE> attributes)
```
    セッション属性ヘッダーにアクセスするための静的な代替手段。
  - getSessionAttributes
```
@Nullable
public MapSE<StringSE,ObjectSE> getSessionAttributes()
```
    現在のセッションに関連付けられている属性を返します。
  - setUser
```
public void setUser(@Nullable
                    PrincipalSE principal)
```
  - getUser
```
@Nullable
public PrincipalSE getUser()
```
    現在のセッションに関連付けられているユーザーを返します。
  - setUserChangeCallback
```
public void setUserChangeCallback(ConsumerSE<PrincipalSE> callback)
```
    setUser(Principal) が呼び出されたときに呼び出されるコールバックを提供します。これは、インターセプターを介したトークンベースの認証を検出するために、受信・チャネルで内部的に使用されます。
    パラメーター:
    callback - 呼び出すコールバック
    導入:
    5.1.9
  - getShortLogMessage
```
public StringSE getShortLogMessage(ObjectSE payload)
```
    クラスからコピーされた説明: MessageHeaderAccessor
    ロギングのために簡潔なメッセージを返します。
    オーバーライド:
    クラス MessageHeaderAccessor の getShortLogMessage
    パラメーター:
    payload - ヘッダーに対応するペイロード。
    戻り値:
    メッセージ
  - getDetailedLogMessage
```
public StringSE getDetailedLogMessage(@Nullable
                                    ObjectSE payload)
```
    クラスからコピーされた説明: MessageHeaderAccessor
    ロギングの目的で、より詳細なメッセージを返します。
    オーバーライド:
    クラス MessageHeaderAccessor の getDetailedLogMessage
    パラメーター:
    payload - ヘッダーに対応するペイロード。
    戻り値:
    メッセージ
  - create
```
public static SimpMessageHeaderAccessor create()
```
    SimpMessageType MESSAGE でインスタンスを作成します。
  - create
```
public static SimpMessageHeaderAccessor create(SimpMessageType messageType)
```
    指定された SimpMessageType でインスタンスを作成します。
  - wrap
```
public static SimpMessageHeaderAccessor wrap(Message<?> message)
```
    指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。
  - getMessageType
```
@Nullable
public static SimpMessageType getMessageType(MapSE<StringSE,ObjectSE> headers)
```
  - getDestination
```
@Nullable
public static StringSE getDestination(MapSE<StringSE,ObjectSE> headers)
```
  - getSubscriptionId
```
@Nullable
public static StringSE getSubscriptionId(MapSE<StringSE,ObjectSE> headers)
```
  - getSessionId
```
@Nullable
public static StringSE getSessionId(MapSE<StringSE,ObjectSE> headers)
```
  - getSessionAttributes
```
@Nullable
public static MapSE<StringSE,ObjectSE> getSessionAttributes(MapSE<StringSE,ObjectSE> headers)
```
  - getUser
```
@Nullable
public static PrincipalSE getUser(MapSE<StringSE,ObjectSE> headers)
```
  - getHeartbeat
```
@Nullable
public static long[] getHeartbeat(MapSE<StringSE,ObjectSE> headers)
```

クラス SimpMessageHeaderAccessor

フィールドサマリー

クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたフィールド

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド

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

メソッドのサマリー

クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたメソッド

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド

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

フィールドの詳細

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

SimpMessageHeaderAccessor

メソッドの詳細

createAccessor

setMessageTypeIfNotSet

getMessageType

setDestination

getDestination

setSubscriptionId

getSubscriptionId

setSessionId

getSessionId

setSessionAttributes

getSessionAttributes

setUser

getUser

setUserChangeCallback

getShortLogMessage

getDetailedLogMessage

create

create

wrap

getMessageType

getDestination

getSubscriptionId

getSessionId

getSessionAttributes

getUser

getHeartbeat