StompHeaderAccessor (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
    - - 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 java.lang.String`	`STOMP_ACCEPT_VERSION_HEADER`
`static java.lang.String`	`STOMP_ACK_HEADER`
`static java.lang.String`	`STOMP_CONTENT_LENGTH_HEADER`
`static java.lang.String`	`STOMP_CONTENT_TYPE_HEADER`
`static java.lang.String`	`STOMP_DESTINATION_HEADER`
`static java.lang.String`	`STOMP_HEARTBEAT_HEADER`
`static java.lang.String`	`STOMP_HOST_HEADER`
`static java.lang.String`	`STOMP_ID_HEADER`
`static java.lang.String`	`STOMP_LOGIN_HEADER`
`static java.lang.String`	`STOMP_MESSAGE_HEADER`
`static java.lang.String`	`STOMP_MESSAGE_ID_HEADER`
`static java.lang.String`	`STOMP_NACK_HEADER`
`static java.lang.String`	`STOMP_PASSCODE_HEADER`
`static java.lang.String`	`STOMP_RECEIPT_HEADER`
`static java.lang.String`	`STOMP_RECEIPT_ID_HEADER`
`static java.lang.String`	`STOMP_SUBSCRIPTION_HEADER`
`static java.lang.String`	`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, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)` 指定された STOMP コマンドとヘッダーのインスタンスを作成します。
`protected MessageHeaderAccessor`	`createAccessor(Message<?> message)` 指定されたメッセージの「ネストされた」アクセサーを構築します。
`static StompHeaderAccessor`	`createForHeartbeat()` ハートビートのヘッダーを作成します。
`java.util.Set<java.lang.String>`	`getAcceptVersion()`
`java.lang.String`	`getAck()`
`StompCommand`	`getCommand()` STOMP コマンドを返すか、まだ設定されていない場合は `null` を返します。
`static StompCommand`	`getCommand(java.util.Map<java.lang.String,java.lang.Object> headers)` 指定されたヘッダーから STOMP コマンドを返します。設定されていない場合は `null` を返します。
`java.lang.Integer`	`getContentLength()`
`static java.lang.Integer`	`getContentLength(java.util.Map<java.lang.String,java.util.List<java.lang.String>> nativeHeaders)`
`java.lang.String`	`getDetailedLogMessage(java.lang.Object payload)` ロギングの目的で、より詳細なメッセージを返します。
`long[]`	`getHeartbeat()`
`java.lang.String`	`getHost()`
`java.lang.String`	`getLogin()`
`java.lang.String`	`getMessage()`
`java.lang.String`	`getMessageId()`
`java.lang.String`	`getNack()`
`protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getNativeHeaders()`
`java.lang.String`	`getPasscode()` パスコードヘッダー値を返します。設定されていない場合は `null` を返します。
`static java.lang.String`	`getPasscode(java.util.Map<java.lang.String,java.lang.Object> headers)` パスコードヘッダー値を返します。設定されていない場合は `null` を返します。
`java.lang.String`	`getReceipt()`
`java.lang.String`	`getReceiptId()`
`java.lang.String`	`getShortLogMessage(java.lang.Object payload)` ロギングのために簡潔なメッセージを返します。
`java.lang.String`	`getVersion()`
`boolean`	`isHeartbeat()`
`void`	`setAcceptVersion(java.lang.String acceptVersion)`
`void`	`setAck(java.lang.String ack)`
`void`	`setContentLength(int contentLength)`
`void`	`setContentType(MimeType contentType)`
`void`	`setDestination(java.lang.String destination)`
`void`	`setHeartbeat(long cx, long cy)`
`void`	`setHost(java.lang.String host)`
`void`	`setLogin(java.lang.String login)`
`void`	`setMessage(java.lang.String content)`
`void`	`setMessageId(java.lang.String id)`
`void`	`setNack(java.lang.String nack)`
`void`	`setPasscode(java.lang.String passcode)`
`void`	`setReceipt(java.lang.String receiptId)`
`void`	`setReceiptId(java.lang.String receiptId)`
`void`	`setSubscriptionId(java.lang.String subscriptionId)`
`void`	`setVersion(java.lang.String 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

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

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

メソッドの詳細

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

getNativeHeaders

@Nullable
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getNativeHeaders()

オーバーライド:: クラス 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(java.lang.String acceptVersion)

getAcceptVersion

public java.util.Set<java.lang.String> getAcceptVersion()

setHost

public void setHost(@Nullable
                    java.lang.String host)

getHost

@Nullable
public java.lang.String getHost()

setDestination

public void setDestination(@Nullable
                           java.lang.String destination)

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

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

setSubscriptionId

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

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

getContentLength

@Nullable
public java.lang.Integer getContentLength()

setContentLength

public void setContentLength(int contentLength)

setHeartbeat

public void setHeartbeat(long cx,
                         long cy)

setAck

public void setAck(@Nullable
                   java.lang.String ack)

getAck

@Nullable
public java.lang.String getAck()

setNack

public void setNack(@Nullable
                    java.lang.String nack)

getNack

@Nullable
public java.lang.String getNack()

setLogin

public void setLogin(@Nullable
                     java.lang.String login)

getLogin

@Nullable
public java.lang.String getLogin()

setPasscode

public void setPasscode(@Nullable
                        java.lang.String passcode)

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

setReceiptId

public void setReceiptId(@Nullable
                         java.lang.String receiptId)

getReceiptId

@Nullable
public java.lang.String getReceiptId()

setReceipt

public void setReceipt(@Nullable
                       java.lang.String receiptId)

getReceipt

@Nullable
public java.lang.String getReceipt()

getMessage

@Nullable
public java.lang.String getMessage()

setMessage

public void setMessage(@Nullable
                       java.lang.String content)

getMessageId

@Nullable
public java.lang.String getMessageId()

setMessageId

public void setMessageId(@Nullable
                         java.lang.String id)

getVersion

@Nullable
public java.lang.String getVersion()

setVersion

public void setVersion(@Nullable
                       java.lang.String version)

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

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

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

create

public static StompHeaderAccessor create(StompCommand command,
                                         java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

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

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

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

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

getPasscode

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

パスコードヘッダー値を返します。設定されていない場合は null を返します。

getContentLength

@Nullable
public static java.lang.Integer getContentLength(java.util.Map<java.lang.String,java.util.List<java.lang.String>> 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.Object から継承されたメソッド

フィールドの詳細

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