StompHeaderAccessor (Spring Framework API)

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

```
public class StompHeaderAccessor
extends SimpMessageHeaderAccessor
```
デコードされた STOMP フレームから Message を作成するとき、または Message を STOMP フレームにエンコードするときに使用する MessageHeaderAccessor。
STOMP フレームコンテンツから作成された場合、実際の STOMP ヘッダーは、親クラス NativeMessageHeaderAccessor によって管理されるネイティブヘッダーサブマップに格納されますが、親クラス SimpMessageHeaderAccessor は、STOMP ヘッダーに基づく共通処理ヘッダー（例: 宛先、コンテンツ型）を管理します。など）。
このクラスのインスタンスは、既存の Message をラップすることでも作成できます。そのメッセージは、より一般的な SimpMessageHeaderAccessor で作成された可能性があり、その場合、STOMP ヘッダーは共通の処理ヘッダーから作成されます。この場合、メッセージを送信する場合、メッセージをクライアントに送信するかメッセージブローカーに送信するかに応じて、updateStompCommandAsClientMessage() または updateStompCommandAsServerMessage() を呼び出す必要もあります。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`STOMP_ACCEPT_VERSION_HEADER`
`static StringSE`	`STOMP_ACK_HEADER`
`static StringSE`	`STOMP_CONTENT_LENGTH_HEADER`
`static StringSE`	`STOMP_CONTENT_TYPE_HEADER`
`static StringSE`	`STOMP_DESTINATION_HEADER`
`static StringSE`	`STOMP_HEARTBEAT_HEADER`
`static StringSE`	`STOMP_HOST_HEADER`
`static StringSE`	`STOMP_ID_HEADER`
`static StringSE`	`STOMP_LOGIN_HEADER`
`static StringSE`	`STOMP_MESSAGE_HEADER`
`static StringSE`	`STOMP_MESSAGE_ID_HEADER`
`static StringSE`	`STOMP_NACK_HEADER`
`static StringSE`	`STOMP_PASSCODE_HEADER`
`static StringSE`	`STOMP_RECEIPT_HEADER`
`static StringSE`	`STOMP_RECEIPT_ID_HEADER`
`static StringSE`	`STOMP_SUBSCRIPTION_HEADER`
`static StringSE`	`STOMP_VERSION_HEADER`

クラス org.springframework.messaging.simp.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

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

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

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static StompHeaderAccessor`	`create(StompCommand command)` 指定された STOMP コマンドのインスタンスを作成します。
`static StompHeaderAccessor`	`create(StompCommand command, MapSE<StringSE, ListSE<StringSE>> headers)` 指定された STOMP コマンドとヘッダーのインスタンスを作成します。
`protected MessageHeaderAccessor`	`createAccessor(Message<?> message)` 指定されたメッセージの「ネストされた」アクセサーを構築します。
`static StompHeaderAccessor`	`createForHeartbeat()` ハートビートのヘッダーを作成します。
`SetSE<StringSE>`	`getAcceptVersion()`
`StringSE`	`getAck()`
`StompCommand`	`getCommand()` STOMP コマンドを返すか、まだ設定されていない場合は `null` を返します。
`static StompCommand`	`getCommand(MapSE<StringSE, ObjectSE> headers)` 指定されたヘッダーから STOMP コマンドを返します。設定されていない場合は `null` を返します。
`IntegerSE`	`getContentLength()`
`static IntegerSE`	`getContentLength(MapSE<StringSE, ListSE<StringSE>> nativeHeaders)`
`StringSE`	`getDetailedLogMessage(ObjectSE payload)` ロギングの目的で、より詳細なメッセージを返します。
`long[]`	`getHeartbeat()`
`StringSE`	`getHost()`
`StringSE`	`getLogin()`
`StringSE`	`getMessage()`
`StringSE`	`getMessageId()`
`StringSE`	`getNack()`
`protected MapSE<StringSE, ListSE<StringSE>>`	`getNativeHeaders()` サブクラスはこのメソッドを使用して、「ネイティブ」ヘッダーサブマップにアクセスできます。
`StringSE`	`getPasscode()` パスコードヘッダー値を返します。設定されていない場合は `null` を返します。
`static StringSE`	`getPasscode(MapSE<StringSE, ObjectSE> headers)` パスコードヘッダー値を返します。設定されていない場合は `null` を返します。
`StringSE`	`getReceipt()`
`StringSE`	`getReceiptId()`
`StringSE`	`getShortLogMessage(ObjectSE payload)` ロギングのために簡潔なメッセージを返します。
`StringSE`	`getVersion()`
`boolean`	`isHeartbeat()`
`void`	`setAcceptVersion(StringSE acceptVersion)`
`void`	`setAck(StringSE ack)`
`void`	`setContentLength(int contentLength)`
`void`	`setContentType(MimeType contentType)`
`void`	`setDestination(StringSE destination)`
`void`	`setHeartbeat(long cx, long cy)`
`void`	`setHost(StringSE host)`
`void`	`setLogin(StringSE login)`
`void`	`setMessage(StringSE content)`
`void`	`setMessageId(StringSE id)`
`void`	`setNack(StringSE nack)`
`void`	`setPasscode(StringSE passcode)`
`void`	`setReceipt(StringSE receiptId)`
`void`	`setReceiptId(StringSE receiptId)`
`void`	`setSubscriptionId(StringSE subscriptionId)`
`void`	`setVersion(StringSE version)`
`StompCommand`	`updateStompCommandAsClientMessage()`
`void`	`updateStompCommandAsServerMessage()`
`static StompHeaderAccessor`	`wrap(Message<?> message)` 指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。

クラス org.springframework.messaging.simp.SimpMessageHeaderAccessor から継承されたメソッド
create, create, getDestination, getDestination, getHeartbeat, getMessageType, getMessageType, getSessionAttributes, getSessionAttributes, getSessionId, getSessionId, getSubscriptionId, getSubscriptionId, getUser, getUser, setMessageTypeIfNotSet, setSessionAttributes, setSessionId, setUser, setUserChangeCallback

クラス org.springframework.messaging.support.NativeMessageHeaderAccessor から継承されたメソッド
addNativeHeader, addNativeHeaders, containsNativeHeader, copyHeaders, copyHeadersIfAbsent, getFirstNativeHeader, getFirstNativeHeader, getNativeHeader, 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, 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

フィールドの詳細
- STOMP_ID_HEADER
```
public static final StringSE STOMP_ID_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_HOST_HEADER
```
public static final StringSE STOMP_HOST_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_ACCEPT_VERSION_HEADER
```
public static final StringSE STOMP_ACCEPT_VERSION_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_MESSAGE_ID_HEADER
```
public static final StringSE STOMP_MESSAGE_ID_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_RECEIPT_HEADER
```
public static final StringSE STOMP_RECEIPT_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_RECEIPT_ID_HEADER
```
public static final StringSE STOMP_RECEIPT_ID_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_SUBSCRIPTION_HEADER
```
public static final StringSE STOMP_SUBSCRIPTION_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_VERSION_HEADER
```
public static final StringSE STOMP_VERSION_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_MESSAGE_HEADER
```
public static final StringSE STOMP_MESSAGE_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_ACK_HEADER
```
public static final StringSE STOMP_ACK_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_NACK_HEADER
```
public static final StringSE STOMP_NACK_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_LOGIN_HEADER
```
public static final StringSE STOMP_LOGIN_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_PASSCODE_HEADER
```
public static final StringSE STOMP_PASSCODE_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_DESTINATION_HEADER
```
public static final StringSE STOMP_DESTINATION_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_CONTENT_TYPE_HEADER
```
public static final StringSE STOMP_CONTENT_TYPE_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_CONTENT_LENGTH_HEADER
```
public static final StringSE STOMP_CONTENT_LENGTH_HEADER
```
  関連事項:
  定数フィールド値
- STOMP_HEARTBEAT_HEADER
```
public static final StringSE STOMP_HEARTBEAT_HEADER
```
  関連事項:
  定数フィールド値

メソッドの詳細

createAccessor
```
protected MessageHeaderAccessor createAccessor(Message<?> message)
```
クラスからコピーされた説明: MessageHeaderAccessor
指定されたメッセージの「ネストされた」アクセサーを構築します。
オーバーライド:
クラス SimpMessageHeaderAccessor の createAccessor
パラメーター:
message - 新しいアクセサーを構築するためのメッセージ
戻り値:
ネストされたアクセサー (通常は特定のサブクラス)

getNativeHeaders
```
@Nullable
protected MapSE<StringSE,ListSE<StringSE>> getNativeHeaders()
```
クラスからコピーされた説明: NativeMessageHeaderAccessor
サブクラスはこのメソッドを使用して、「ネイティブ」ヘッダーサブマップにアクセスできます。
オーバーライド:
クラス NativeMessageHeaderAccessor の getNativeHeaders

updateStompCommandAsClientMessage

public StompCommand updateStompCommandAsClientMessage()

updateStompCommandAsServerMessage

public void updateStompCommandAsServerMessage()

getCommand
```
@Nullable
public StompCommand getCommand()
```
STOMP コマンドを返すか、まだ設定されていない場合は null を返します。

isHeartbeat
```
public boolean isHeartbeat()
```

getHeartbeat
```
public long[] getHeartbeat()
```

setAcceptVersion

public void setAcceptVersion(StringSE acceptVersion)

getAcceptVersion

public SetSE<StringSE> getAcceptVersion()

setHost

public void setHost(@Nullable
                    StringSE host)

getHost
```
@Nullable
public StringSE getHost()
```

setDestination

public void setDestination(@Nullable
                           StringSE destination)

オーバーライド:: クラス SimpMessageHeaderAccessor の setDestination

setContentType
```
public void setContentType(MimeType contentType)
```
オーバーライド:
クラス MessageHeaderAccessor の setContentType

setSubscriptionId

public void setSubscriptionId(@Nullable
                              StringSE subscriptionId)

オーバーライド:: クラス SimpMessageHeaderAccessor の setSubscriptionId

getContentLength

@Nullable
public IntegerSE getContentLength()

setContentLength

public void setContentLength(int contentLength)

setHeartbeat

public void setHeartbeat(long cx,
                         long cy)

setAck

public void setAck(@Nullable
                   StringSE ack)

getAck
```
@Nullable
public StringSE getAck()
```

setNack

public void setNack(@Nullable
                    StringSE nack)

getNack
```
@Nullable
public StringSE getNack()
```

setLogin

public void setLogin(@Nullable
                     StringSE login)

getLogin
```
@Nullable
public StringSE getLogin()
```

setPasscode

public void setPasscode(@Nullable
                        StringSE passcode)

getPasscode
```
@Nullable
public StringSE getPasscode()
```
パスコードヘッダー値を返します。設定されていない場合は null を返します。

setReceiptId

public void setReceiptId(@Nullable
                         StringSE receiptId)

getReceiptId

@Nullable
public StringSE getReceiptId()

setReceipt

public void setReceipt(@Nullable
                       StringSE receiptId)

getReceipt

@Nullable
public StringSE getReceipt()

getMessage

@Nullable
public StringSE getMessage()

setMessage

public void setMessage(@Nullable
                       StringSE content)

getMessageId

@Nullable
public StringSE getMessageId()

setMessageId

public void setMessageId(@Nullable
                         StringSE id)

getVersion

@Nullable
public StringSE getVersion()

setVersion

public void setVersion(@Nullable
                       StringSE version)

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

getDetailedLogMessage
```
public StringSE getDetailedLogMessage(@Nullable
                                    ObjectSE payload)
```
クラスからコピーされた説明: MessageHeaderAccessor
ロギングの目的で、より詳細なメッセージを返します。
オーバーライド:
クラス SimpMessageHeaderAccessor の getDetailedLogMessage
パラメーター:
payload - ヘッダーに対応するペイロード。
戻り値:
メッセージ

create
```
public static StompHeaderAccessor create(StompCommand command)
```
指定された STOMP コマンドのインスタンスを作成します。

create

public static StompHeaderAccessor create(StompCommand command,
                                         MapSE<StringSE,ListSE<StringSE>> headers)

指定された STOMP コマンドとヘッダーのインスタンスを作成します。

createForHeartbeat
```
public static StompHeaderAccessor createForHeartbeat()
```
ハートビートのヘッダーを作成します。STOMP ハートビートフレームにはヘッダーがありませんが、少なくとも処理の目的でセッション ID が必要です。

wrap
```
public static StompHeaderAccessor wrap(Message<?> message)
```
指定されたメッセージのペイロードとヘッダーからインスタンスを作成します。

getCommand
```
@Nullable
public static StompCommand getCommand(MapSE<StringSE,ObjectSE> headers)
```
指定されたヘッダーから STOMP コマンドを返します。設定されていない場合は null を返します。

getPasscode
```
@Nullable
public static StringSE getPasscode(MapSE<StringSE,ObjectSE> headers)
```
パスコードヘッダー値を返します。設定されていない場合は null を返します。

getContentLength

@Nullable
public static IntegerSE getContentLength(MapSE<StringSE,ListSE<StringSE>> nativeHeaders)

クラス StompHeaderAccessor

フィールドのサマリー

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

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

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

メソッドのサマリー

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

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

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

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

フィールドの詳細

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

getNativeHeaders

updateStompCommandAsClientMessage

updateStompCommandAsServerMessage

getCommand

isHeartbeat

getHeartbeat

setAcceptVersion

getAcceptVersion

setHost

getHost

setDestination

setContentType

setSubscriptionId

getContentLength

setContentLength

setHeartbeat

setAck

getAck

setNack

getNack

setLogin

getLogin

setPasscode

getPasscode

setReceiptId

getReceiptId

setReceipt

getReceipt

getMessage

setMessage

getMessageId

setMessageId

getVersion

setVersion

getShortLogMessage

getDetailedLogMessage

create

create

createForHeartbeat

wrap

getCommand

getPasscode

getContentLength