NativeMessageHeaderAccessor (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- org.springframework.messaging.support.MessageHeaderAccessor
- - org.springframework.messaging.support.NativeMessageHeaderAccessor

既知の直属サブクラス
JmsMessageHeaderAccessor, SimpMessageHeaderAccessor
```
public class NativeMessageHeaderAccessor
extends MessageHeaderAccessor
```
外部ソースからのメッセージヘッダーへの読み取り / 書き込みアクセスも保存および提供する MessageHeaderAccessor の拡張機能。STOMP クライアントまたはメッセージブローカーから受信した STOMP メッセージを表すために作成された Spring Message ネイティブメッセージヘッダーは、キー NATIVE_HEADERS の Map<String, List<String>> に保持されます。
このクラスは直接使用するためのものではなく、StompHeaderAccessor などのプロトコル固有のサブクラスを介して間接的に使用されることが想定されています。このようなサブクラスは、メッセージヘッダーを外部メッセージングソース（STOMP など）から Spring Message ヘッダーに変換し、逆に Spring Message ヘッダーをメッセージに変換して外部ソースに送信するファクトリメソッドを提供します。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールド概要
フィールド
修飾子と型フィールドと説明
static java.lang.String NATIVE_HEADERS
ネイティブヘッダーの格納に使用されるヘッダー名。
- クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド
  DEFAULT_CHARSET

フィールド
修飾子と型	フィールドと説明
`static java.lang.String`	`NATIVE_HEADERS` ネイティブヘッダーの格納に使用されるヘッダー名。

コンストラクター概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`NativeMessageHeaderAccessor()` 新しいヘッダーを作成するための protected コンストラクター。
`protected`	`NativeMessageHeaderAccessor(java.util.Map<java.lang.String,java.util.List<java.lang.String>> nativeHeaders)` 新しいヘッダーを作成するための protected コンストラクター。
`protected`	`NativeMessageHeaderAccessor(Message<?> message)` コピーする既存のメッセージのヘッダーを受け入れる protected コンストラクター。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addNativeHeader(java.lang.String name, java.lang.String value)` 指定したネイティブヘッダー値を既存の値に追加します。
`void`	`addNativeHeaders(MultiValueMap<java.lang.String,java.lang.String> headers)`
`boolean`	`containsNativeHeader(java.lang.String headerName)` ネイティブヘッダーマップに特定のヘッダー名が含まれているかどうか。
`java.lang.String`	`getFirstNativeHeader(java.lang.String headerName)` 指定されたネイティブヘッダーの最初の値を返します。ない場合は `null` を返します。
`static java.lang.String`	`getFirstNativeHeader(java.lang.String headerName, java.util.Map<java.lang.String,java.lang.Object> headers)`
`java.util.List<java.lang.String>`	`getNativeHeader(java.lang.String headerName)` 指定されたネイティブヘッダーのすべての値を返します。
`protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getNativeHeaders()`
`java.util.List<java.lang.String>`	`removeNativeHeader(java.lang.String name)`
`void`	`setImmutable()` デフォルトでは、`MessageHeaderAccessor.getMessageHeaders()` が呼び出されると、`"this"` `MessageHeaderAccessor` インスタンスを使用して基になるメッセージヘッダーを変更することはできなくなります。
`void`	`setNativeHeader(java.lang.String name, java.lang.String value)` 既存の値を置き換えて、指定されたネイティブヘッダー値を設定します。
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`toNativeHeaderMap()` ネイティブヘッダー値のコピーまたは空のマップを返します。

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド
copyHeaders, copyHeadersIfAbsent, createAccessor, getAccessor, getAccessor, getContentType, getDetailedLogMessage, getDetailedPayloadLogMessage, getErrorChannel, getHeader, getId, getMessageHeaders, getMutableAccessor, getReplyChannel, getShortLogMessage, 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

- フィールドの詳細
  - NATIVE_HEADERS
```
public static final java.lang.String NATIVE_HEADERS
```
    ネイティブヘッダーの格納に使用されるヘッダー名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - NativeMessageHeaderAccessor
```
protected NativeMessageHeaderAccessor()
```
    新しいヘッダーを作成するための protected コンストラクター。
  - NativeMessageHeaderAccessor
```
protected NativeMessageHeaderAccessor(@Nullable
                                      java.util.Map<java.lang.String,java.util.List<java.lang.String>> nativeHeaders)
```
    新しいヘッダーを作成するための protected コンストラクター。
    パラメーター:
    nativeHeaders - メッセージを作成するためのネイティブヘッダー (null の場合があります)
  - NativeMessageHeaderAccessor
```
protected NativeMessageHeaderAccessor(@Nullable
                                      Message<?> message)
```
    コピーする既存のメッセージのヘッダーを受け入れる protected コンストラクター。
- メソッドの詳細
  - getNativeHeaders
```
@Nullable
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getNativeHeaders()
```
  - toNativeHeaderMap
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> toNativeHeaderMap()
```
    ネイティブヘッダー値のコピーまたは空のマップを返します。
  - setImmutable
```
public void setImmutable()
```
    クラスからコピーされた説明: MessageHeaderAccessor
    デフォルトでは、MessageHeaderAccessor.getMessageHeaders() が呼び出されると、"this" MessageHeaderAccessor インスタンスを使用して基になるメッセージヘッダーを変更することはできなくなります。ただし、MessageHeaderAccessor.setLeaveMutable(boolean) を使用する場合、このメソッドは、MessageHeaders インスタンスを変更する必要がなくなる時期を明示的に示すために必要です。
    オーバーライド:
    クラス MessageHeaderAccessor の setImmutable
  - containsNativeHeader
```
public boolean containsNativeHeader(java.lang.String headerName)
```
    ネイティブヘッダーマップに特定のヘッダー名が含まれているかどうか。
  - getNativeHeader
```
@Nullable
public java.util.List<java.lang.String> getNativeHeader(java.lang.String headerName)
```
    指定したネイティブヘッダーのすべての値を返します。ない場合は null。
  - getFirstNativeHeader
```
@Nullable
public java.lang.String getFirstNativeHeader(java.lang.String headerName)
```
    指定されたネイティブヘッダーの最初の値を返します。ない場合は null を返します。
  - setNativeHeader
```
public void setNativeHeader(java.lang.String name,
                            @Nullable
                            java.lang.String value)
```
    既存の値を置き換えて、指定されたネイティブヘッダー値を設定します。
  - addNativeHeader
```
public void addNativeHeader(java.lang.String name,
                            @Nullable
                            java.lang.String value)
```
    指定したネイティブヘッダー値を既存の値に追加します。
  - addNativeHeaders
```
public void addNativeHeaders(@Nullable
                             MultiValueMap<java.lang.String,java.lang.String> headers)
```
  - removeNativeHeader
```
@Nullable
public java.util.List<java.lang.String> removeNativeHeader(java.lang.String name)
```
  - getFirstNativeHeader
```
@Nullable
public static java.lang.String getFirstNativeHeader(java.lang.String headerName,
                                                              java.util.Map<java.lang.String,java.lang.Object> headers)
```

クラス NativeMessageHeaderAccessor

フィールド概要

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

コンストラクター概要

方法の概要

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

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

フィールドの詳細

NATIVE_HEADERS

コンストラクターの詳細

NativeMessageHeaderAccessor

NativeMessageHeaderAccessor

NativeMessageHeaderAccessor

メソッドの詳細

getNativeHeaders

toNativeHeaderMap

setImmutable

containsNativeHeader

getNativeHeader

getFirstNativeHeader

setNativeHeader

addNativeHeader

addNativeHeaders

removeNativeHeader

getFirstNativeHeader