SimpMessageHeaderAccessor (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- 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 java.lang.String`	`CONNECT_MESSAGE_HEADER`
`static java.lang.String`	`DESTINATION_HEADER`
`static java.lang.String`	`DISCONNECT_MESSAGE_HEADER`
`static java.lang.String`	`HEART_BEAT_HEADER`
`static java.lang.String`	`IGNORE_ERROR` 送信者がエラーを無視することをブローカーに示すヘッダー。
`static java.lang.String`	`MESSAGE_TYPE_HEADER`
`static java.lang.String`	`ORIGINAL_DESTINATION` クライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。
`static java.lang.String`	`SESSION_ATTRIBUTES`
`static java.lang.String`	`SESSION_ID_HEADER`
`static java.lang.String`	`SUBSCRIPTION_ID_HEADER`
`static java.lang.String`	`USER_HEADER`

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

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

コンストラクター概要

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

方法の概要

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

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

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド
copyHeaders, copyHeadersIfAbsent, 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.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細
- DESTINATION_HEADER
```
public static final java.lang.String DESTINATION_HEADER
```
  関連事項:
  定数フィールド値
- MESSAGE_TYPE_HEADER
```
public static final java.lang.String MESSAGE_TYPE_HEADER
```
  関連事項:
  定数フィールド値
- SESSION_ID_HEADER
```
public static final java.lang.String SESSION_ID_HEADER
```
  関連事項:
  定数フィールド値
- SESSION_ATTRIBUTES
```
public static final java.lang.String SESSION_ATTRIBUTES
```
  関連事項:
  定数フィールド値
- SUBSCRIPTION_ID_HEADER
```
public static final java.lang.String SUBSCRIPTION_ID_HEADER
```
  関連事項:
  定数フィールド値
- USER_HEADER
```
public static final java.lang.String USER_HEADER
```
  関連事項:
  定数フィールド値
- CONNECT_MESSAGE_HEADER
```
public static final java.lang.String CONNECT_MESSAGE_HEADER
```
  関連事項:
  定数フィールド値
- DISCONNECT_MESSAGE_HEADER
```
public static final java.lang.String DISCONNECT_MESSAGE_HEADER
```
  関連事項:
  定数フィールド値
- HEART_BEAT_HEADER
```
public static final java.lang.String HEART_BEAT_HEADER
```
  関連事項:
  定数フィールド値
- ORIGINAL_DESTINATION
```
public static final java.lang.String ORIGINAL_DESTINATION
```
  クライアントにメッセージを送信する前に宛先を復元する必要がある「ユーザー」宛先での内部使用のためのヘッダー。
  関連事項:
  定数フィールド値
- IGNORE_ERROR
```
public static final java.lang.String IGNORE_ERROR
```
  送信者がエラーを無視することをブローカーに示すヘッダー。ヘッダーは単に存在または不在をチェックされます。
  関連事項:
  定数フィールド値

コンストラクターの詳細
- SimpMessageHeaderAccessor
```
protected SimpMessageHeaderAccessor(SimpMessageType messageType,
                                    @Nullable
                                    java.util.Map<java.lang.String,java.util.List<java.lang.String>> 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
                           java.lang.String destination)

getDestination

@Nullable
public java.lang.String getDestination()

setSubscriptionId

public void setSubscriptionId(@Nullable
                              java.lang.String subscriptionId)

getSubscriptionId

@Nullable
public java.lang.String getSubscriptionId()

setSessionId

public void setSessionId(@Nullable
                         java.lang.String sessionId)

getSessionId
```
@Nullable
public java.lang.String getSessionId()
```
現在のセッションの ID を返します。

setSessionAttributes

public void setSessionAttributes(@Nullable
                                 java.util.Map<java.lang.String,java.lang.Object> attributes)

セッション属性ヘッダーにアクセスするための静的な代替手段。

getSessionAttributes
```
@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getSessionAttributes()
```
現在のセッションに関連付けられている属性を返します。

setUser

public void setUser(@Nullable
                    java.security.Principal principal)

getUser
```
@Nullable
public java.security.Principal getUser()
```
現在のセッションに関連付けられているユーザーを返します。

getShortLogMessage
```
public java.lang.String getShortLogMessage(java.lang.Object payload)
```
クラスからコピーされた説明: MessageHeaderAccessor
ロギングのために簡潔なメッセージを返します。
オーバーライド:
クラス MessageHeaderAccessor の getShortLogMessage
パラメーター:
payload - ヘッダーに対応するペイロード。
戻り値:
メッセージ

getDetailedLogMessage
```
public java.lang.String getDetailedLogMessage(@Nullable
                                              java.lang.Object 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(java.util.Map<java.lang.String,java.lang.Object> headers)

getDestination

@Nullable
public static java.lang.String getDestination(java.util.Map<java.lang.String,java.lang.Object> headers)

getSubscriptionId

@Nullable
public static java.lang.String getSubscriptionId(java.util.Map<java.lang.String,java.lang.Object> headers)

getSessionId

@Nullable
public static java.lang.String getSessionId(java.util.Map<java.lang.String,java.lang.Object> headers)

getSessionAttributes

@Nullable
public static java.util.Map<java.lang.String,java.lang.Object> getSessionAttributes(java.util.Map<java.lang.String,java.lang.Object> headers)

getUser

@Nullable
public static java.security.Principal getUser(java.util.Map<java.lang.String,java.lang.Object> headers)

getHeartbeat

@Nullable
public static long[] getHeartbeat(java.util.Map<java.lang.String,java.lang.Object> headers)

クラス SimpMessageHeaderAccessor

フィールド概要

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

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

コンストラクター概要

方法の概要

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

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

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

フィールドの詳細

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

getShortLogMessage

getDetailedLogMessage

create

create

wrap

getMessageType

getDestination

getSubscriptionId

getSessionId

getSessionAttributes

getUser

getHeartbeat