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
```
A MessageHeaderAccessor to use when creating a Message from a decoded STOMP frame, or when encoding a Message to a STOMP frame.
When created from STOMP frame content, the actual STOMP headers are stored in the native header sub-map managed by the parent class NativeMessageHeaderAccessor while the parent class SimpMessageHeaderAccessor manages common processing headers some of which are based on STOMP headers (e.g. destination, content-type, etc).
An instance of this class can also be created by wrapping an existing Message. That message may have been created with the more generic SimpMessageHeaderAccessor in which case STOMP headers are created from common processing headers. In this case it is also necessary to invoke either updateStompCommandAsClientMessage() or updateStompCommandAsServerMessage() if sending a message and depending on whether a message is sent to a client or the message broker.
从以下版本开始:
4.0
作者:
Rossen Stoyanchev

字段概要

字段
修饰符和类型	字段	说明
`static String`	`STOMP_ACCEPT_VERSION_HEADER`
`static String`	`STOMP_ACK_HEADER`
`static String`	`STOMP_CONTENT_LENGTH_HEADER`
`static String`	`STOMP_CONTENT_TYPE_HEADER`
`static String`	`STOMP_DESTINATION_HEADER`
`static String`	`STOMP_HEARTBEAT_HEADER`
`static String`	`STOMP_HOST_HEADER`
`static String`	`STOMP_ID_HEADER`
`static String`	`STOMP_LOGIN_HEADER`
`static String`	`STOMP_MESSAGE_HEADER`
`static String`	`STOMP_MESSAGE_ID_HEADER`
`static String`	`STOMP_NACK_HEADER`
`static String`	`STOMP_PASSCODE_HEADER`
`static String`	`STOMP_RECEIPT_HEADER`
`static String`	`STOMP_RECEIPT_ID_HEADER`
`static String`	`STOMP_SUBSCRIPTION_HEADER`
`static 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)`	Create an instance for the given STOMP command.
`static StompHeaderAccessor`	`create(StompCommand command, Map<String,List<String>> headers)`	Create an instance for the given STOMP command and headers.
`protected MessageHeaderAccessor`	`createAccessor(Message<?> message)`	Build a 'nested' accessor for the given message.
`static StompHeaderAccessor`	`createForHeartbeat()`	Create headers for a heartbeat.
`Set<String>`	`getAcceptVersion()`
`String`	`getAck()`
`StompCommand`	`getCommand()`	Return the STOMP command, or `null` if not yet set.
`static StompCommand`	`getCommand(Map<String,Object> headers)`	Return the STOMP command from the given headers, or `null` if not set.
`Integer`	`getContentLength()`
`static Integer`	`getContentLength(Map<String,List<String>> nativeHeaders)`
`String`	`getDetailedLogMessage(Object payload)`	Return a more detailed message for logging purposes.
`long[]`	`getHeartbeat()`
`String`	`getHost()`
`String`	`getLogin()`
`String`	`getMessage()`
`String`	`getMessageId()`
`String`	`getNack()`
`String`	`getPasscode()`	Return the passcode header value, or `null` if not set.
`static String`	`getPasscode(Map<String,Object> headers)`	Return the passcode header value, or `null` if not set.
`String`	`getReceipt()`
`String`	`getReceiptId()`
`String`	`getShortLogMessage(Object payload)`	Return a concise message for logging purposes.
`String`	`getVersion()`
`boolean`	`isHeartbeat()`
`void`	`setAcceptVersion(String acceptVersion)`
`void`	`setAck(String ack)`
`void`	`setContentLength(int contentLength)`
`void`	`setContentType(MimeType contentType)`
`void`	`setDestination(String destination)`
`void`	`setHeartbeat(long cx, long cy)`
`void`	`setHost(String host)`
`void`	`setLogin(String login)`
`void`	`setMessage(String content)`
`void`	`setMessageId(String id)`
`void`	`setNack(String nack)`
`void`	`setPasscode(String passcode)`
`void`	`setReceipt(String receiptId)`
`void`	`setReceiptId(String receiptId)`
`void`	`setSubscriptionId(String subscriptionId)`
`void`	`setVersion(String version)`
`StompCommand`	`updateStompCommandAsClientMessage()`
`void`	`updateStompCommandAsServerMessage()`
`static StompHeaderAccessor`	`wrap(Message<?> message)`	Create an instance from the payload and headers of the given 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 String STOMP_ID_HEADER

另请参阅:: 常量字段值

STOMP_HOST_HEADER

public static final String STOMP_HOST_HEADER

另请参阅:: 常量字段值

STOMP_ACCEPT_VERSION_HEADER

public static final String STOMP_ACCEPT_VERSION_HEADER

另请参阅:: 常量字段值

STOMP_MESSAGE_ID_HEADER

public static final String STOMP_MESSAGE_ID_HEADER

另请参阅:: 常量字段值

STOMP_RECEIPT_HEADER

public static final String STOMP_RECEIPT_HEADER

另请参阅:: 常量字段值

STOMP_RECEIPT_ID_HEADER

public static final String STOMP_RECEIPT_ID_HEADER

另请参阅:: 常量字段值

STOMP_SUBSCRIPTION_HEADER

public static final String STOMP_SUBSCRIPTION_HEADER

另请参阅:: 常量字段值

STOMP_VERSION_HEADER

public static final String STOMP_VERSION_HEADER

另请参阅:: 常量字段值

STOMP_MESSAGE_HEADER

public static final String STOMP_MESSAGE_HEADER

另请参阅:: 常量字段值

STOMP_ACK_HEADER

public static final String STOMP_ACK_HEADER

另请参阅:: 常量字段值

STOMP_NACK_HEADER

public static final String STOMP_NACK_HEADER

另请参阅:: 常量字段值

STOMP_LOGIN_HEADER

public static final String STOMP_LOGIN_HEADER

另请参阅:: 常量字段值

STOMP_PASSCODE_HEADER

public static final String STOMP_PASSCODE_HEADER

另请参阅:: 常量字段值

STOMP_DESTINATION_HEADER

public static final String STOMP_DESTINATION_HEADER

另请参阅:: 常量字段值

STOMP_CONTENT_TYPE_HEADER

public static final String STOMP_CONTENT_TYPE_HEADER

另请参阅:: 常量字段值

STOMP_CONTENT_LENGTH_HEADER

public static final String STOMP_CONTENT_LENGTH_HEADER

另请参阅:: 常量字段值

STOMP_HEARTBEAT_HEADER

public static final String STOMP_HEARTBEAT_HEADER

另请参阅:: 常量字段值

方法详细资料

createAccessor
```
protected MessageHeaderAccessor createAccessor(Message<?> message)
```
从类复制的说明: MessageHeaderAccessor
Build a 'nested' accessor for the given message.
覆盖:
createAccessor 在类中 SimpMessageHeaderAccessor
参数:
message - the message to build a new accessor for
返回:
the nested accessor (typically a specific subclass)

updateStompCommandAsClientMessage

public StompCommand updateStompCommandAsClientMessage()

updateStompCommandAsServerMessage

public void updateStompCommandAsServerMessage()

getCommand
```
public StompCommand getCommand()
```
Return the STOMP command, or null if not yet set.

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

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

setAcceptVersion

public void setAcceptVersion(String acceptVersion)

getAcceptVersion
```
public Set<String> getAcceptVersion()
```

setHost
```
public void setHost(String host)
```

getHost
```
public String getHost()
```

setDestination
```
public void setDestination(String destination)
```
覆盖:
setDestination 在类中 SimpMessageHeaderAccessor

setContentType
```
public void setContentType(MimeType contentType)
```
覆盖:
setContentType 在类中 MessageHeaderAccessor

setSubscriptionId
```
public void setSubscriptionId(String subscriptionId)
```
覆盖:
setSubscriptionId 在类中 SimpMessageHeaderAccessor

getContentLength
```
public Integer getContentLength()
```

setContentLength

public void setContentLength(int contentLength)

setHeartbeat

public void setHeartbeat(long cx,
                         long cy)

setAck
```
public void setAck(String ack)
```

getAck
```
public String getAck()
```

setNack
```
public void setNack(String nack)
```

getNack
```
public String getNack()
```

setLogin

public void setLogin(String login)

getLogin
```
public String getLogin()
```

setPasscode

public void setPasscode(String passcode)

getPasscode
```
public String getPasscode()
```
Return the passcode header value, or null if not set.

setReceiptId

public void setReceiptId(String receiptId)

getReceiptId
```
public String getReceiptId()
```

setReceipt

public void setReceipt(String receiptId)

getReceipt
```
public String getReceipt()
```

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String content)

getMessageId
```
public String getMessageId()
```

setMessageId

public void setMessageId(String id)

getVersion
```
public String getVersion()
```

setVersion

public void setVersion(String version)

getShortLogMessage
```
public String getShortLogMessage(Object payload)
```
从类复制的说明: MessageHeaderAccessor
Return a concise message for logging purposes.
覆盖:
getShortLogMessage 在类中 SimpMessageHeaderAccessor
参数:
payload - the payload that corresponds to the headers.
返回:
the message

getDetailedLogMessage
```
public String getDetailedLogMessage(Object payload)
```
从类复制的说明: MessageHeaderAccessor
Return a more detailed message for logging purposes.
覆盖:
getDetailedLogMessage 在类中 SimpMessageHeaderAccessor
参数:
payload - the payload that corresponds to the headers.
返回:
the message

create

public static StompHeaderAccessor create(StompCommand command)

Create an instance for the given STOMP command.

create

public static StompHeaderAccessor create(StompCommand command,
                                         Map<String,List<String>> headers)

Create an instance for the given STOMP command and headers.

createForHeartbeat
```
public static StompHeaderAccessor createForHeartbeat()
```
Create headers for a heartbeat. While a STOMP heartbeat frame does not have headers, a session id is needed for processing purposes at a minimum.

wrap
```
public static StompHeaderAccessor wrap(Message<?> message)
```
Create an instance from the payload and headers of the given Message.

getCommand

public static StompCommand getCommand(Map<String,Object> headers)

Return the STOMP command from the given headers, or null if not set.

getPasscode

public static String getPasscode(Map<String,Object> headers)

Return the passcode header value, or null if not set.

getContentLength

public static Integer getContentLength(Map<String,List<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

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