Spring Messaging 6.1.4 · org.springframework.messaging.simp.stomp.StompHeaderAccessor

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 org.springframework.messaging.support.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 org.springframework.messaging.simp.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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	StompHeaderAccessor.StompPasscode

Field Summary

Modifier and Type	Field and Description
private static final String	COMMAND_HEADER
private static final String	CREDENTIALS_HEADER
private static final long[]	DEFAULT_HEARTBEAT
private static final AtomicLong	messageIdCounter
public static final String	STOMP_ACCEPT_VERSION_HEADER
public static final String	STOMP_ACK_HEADER
public static final String	STOMP_CONTENT_LENGTH_HEADER
public static final String	STOMP_CONTENT_TYPE_HEADER
public static final String	STOMP_DESTINATION_HEADER
public static final String	STOMP_HEARTBEAT_HEADER
public static final String	STOMP_HOST_HEADER
public static final String	STOMP_ID_HEADER
public static final String	STOMP_LOGIN_HEADER
public static final String	STOMP_MESSAGE_HEADER
public static final String	STOMP_MESSAGE_ID_HEADER
public static final String	STOMP_NACK_HEADER
public static final String	STOMP_PASSCODE_HEADER
public static final String	STOMP_RECEIPT_HEADER
public static final String	STOMP_RECEIPT_ID_HEADER
public static final String	STOMP_SUBSCRIPTION_HEADER
public static final String	STOMP_VERSION_HEADER

Inherited from 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

Constructor Summary

Access	Constructor and Description
pack-priv	StompHeaderAccessor(StompCommand command, Map<String, List<String>> externalSourceHeaders) A constructor for creating message headers from a parsed STOMP frame.
pack-priv	StompHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers.
pack-priv	StompHeaderAccessor()

Method Summary

Modifier and Type	Method and Description
private String	appendPayload(Object payload)
private String	appendSession()
public static StompHeaderAccessor	create(StompCommand command) Create an instance for the given STOMP command.
public static StompHeaderAccessor	create(StompCommand command, Map<String, List<String>> headers) Create an instance for the given STOMP command and headers.
protected MessageHeaderAccessor	createAccessor(Message<?> the message to build a new accessor for message) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.createAccessor. Build a 'nested' accessor for the given message.
public static StompHeaderAccessor	createForHeartbeat() Create headers for a heartbeat.
public Set<String>	getAcceptVersion()
public String	getAck()
public StompCommand	getCommand() Return the STOMP command, or `null` if not yet set.
public static StompCommand	getCommand(Map<String, Object> headers) Return the STOMP command from the given headers, or `null` if not set.
public Integer	getContentLength()
public static Integer	getContentLength(Map<String, List<String>> nativeHeaders)
public String	getDetailedLogMessage(Object the payload that corresponds to the headers. payload) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.getDetailedLogMessage. Return a more detailed message for logging purposes.
public long[]	getHeartbeat()
public String	getHost()
public String	getLogin()
public String	getMessage()
public String	getMessageId()
public String	getNack()
protected Map<String, List<String>>	getNativeHeaders() Overrides org.springframework.messaging.support.NativeMessageHeaderAccessor.getNativeHeaders. Subclasses can use this method to access the "native" headers sub-map.
public String	getPasscode() Return the passcode header value, or `null` if not set.
public static String	getPasscode(Map<String, Object> headers) Return the passcode header value, or `null` if not set.
public String	getReceipt()
public String	getReceiptId()
public String	getShortLogMessage(Object the payload that corresponds to the headers. payload) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.getShortLogMessage. Return a concise message for logging purposes.
public String	getVersion()
public boolean	isHeartbeat()
private void	protectPasscode()
public void	setAcceptVersion(String acceptVersion)
public void	setAck(String ack)
public void	setContentLength(int contentLength)
public void	setContentType(MimeType contentType) Overrides org.springframework.messaging.support.MessageHeaderAccessor.setContentType.
public void	setDestination(String destination) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.setDestination.
public void	setHeartbeat(long cx, long cy)
public void	setHost(String host)
public void	setLogin(String login)
public void	setMessage(String content)
public void	setMessageId(String id)
public void	setNack(String nack)
public void	setPasscode(String passcode)
public void	setReceipt(String receiptId)
public void	setReceiptId(String receiptId)
public void	setSubscriptionId(String subscriptionId) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.setSubscriptionId.
public void	setVersion(String version)
private void	trySetStompHeaderForSubscriptionId()
pack-priv void	updateSimpMessageHeadersFromStompHeaders()
public StompCommand	updateStompCommandAsClientMessage()
public void	updateStompCommandAsServerMessage()
pack-priv void	updateStompHeadersFromSimpMessageHeaders()
public static StompHeaderAccessor	wrap(Message<?> message) Hides org.springframework.messaging.simp.SimpMessageHeaderAccessor.wrap. Create an instance from the payload and headers of the given Message.

Field Detail

COMMAND_HEADER	back to summary
private static final String COMMAND_HEADER

CREDENTIALS_HEADER	back to summary
private static final String CREDENTIALS_HEADER

DEFAULT_HEARTBEAT	back to summary
private static final long[] DEFAULT_HEARTBEAT

messageIdCounter	back to summary
private static final AtomicLong messageIdCounter

STOMP_ACCEPT_VERSION_HEADER	back to summary
public static final String STOMP_ACCEPT_VERSION_HEADER

STOMP_ACK_HEADER	back to summary
public static final String STOMP_ACK_HEADER

STOMP_CONTENT_LENGTH_HEADER	back to summary
public static final String STOMP_CONTENT_LENGTH_HEADER

STOMP_CONTENT_TYPE_HEADER	back to summary
public static final String STOMP_CONTENT_TYPE_HEADER

STOMP_DESTINATION_HEADER	back to summary
public static final String STOMP_DESTINATION_HEADER

STOMP_HEARTBEAT_HEADER	back to summary
public static final String STOMP_HEARTBEAT_HEADER

STOMP_HOST_HEADER	back to summary
public static final String STOMP_HOST_HEADER

STOMP_ID_HEADER	back to summary
public static final String STOMP_ID_HEADER

STOMP_LOGIN_HEADER	back to summary
public static final String STOMP_LOGIN_HEADER

STOMP_MESSAGE_HEADER	back to summary
public static final String STOMP_MESSAGE_HEADER

STOMP_MESSAGE_ID_HEADER	back to summary
public static final String STOMP_MESSAGE_ID_HEADER

STOMP_NACK_HEADER	back to summary
public static final String STOMP_NACK_HEADER

STOMP_PASSCODE_HEADER	back to summary
public static final String STOMP_PASSCODE_HEADER

STOMP_RECEIPT_HEADER	back to summary
public static final String STOMP_RECEIPT_HEADER

STOMP_RECEIPT_ID_HEADER	back to summary
public static final String STOMP_RECEIPT_ID_HEADER

STOMP_SUBSCRIPTION_HEADER	back to summary
public static final String STOMP_SUBSCRIPTION_HEADER

STOMP_VERSION_HEADER	back to summary
public static final String STOMP_VERSION_HEADER

Constructor Detail

StompHeaderAccessor	back to summary
pack-priv StompHeaderAccessor(StompCommand command, Map<String, List<String>> externalSourceHeaders) A constructor for creating message headers from a parsed STOMP frame.

StompHeaderAccessor	back to summary
pack-priv StompHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers. Note that the message headers may not have been created from a STOMP frame but may have rather originated from using the more generic `org.springframework.messaging.simp.SimpMessageHeaderAccessor`.

StompHeaderAccessor	back to summary
pack-priv StompHeaderAccessor()

Method Detail

appendPayload	back to summary
private String appendPayload(Object payload)

appendSession	back to summary
private String appendSession()

create	back to summary
public static StompHeaderAccessor create(StompCommand command) Create an instance for the given STOMP command.

create	back to summary
public static StompHeaderAccessor create(StompCommand command, Map<String, List<String>> headers) Create an instance for the given STOMP command and headers.

createAccessor	back to summary
protected MessageHeaderAccessor createAccessor(Message<?> message) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.createAccessor. Doc from org.springframework.messaging.support.MessageHeaderAccessor.createAccessor. Build a 'nested' accessor for the given message. Parameters message:Message<?> the message to build a new accessor for Returns:MessageHeaderAccessor the nested accessor (typically a specific subclass) Annotations @Override

createAccessor

back to summary

protected MessageHeaderAccessor createAccessor(Message<?> message)

Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.createAccessor.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.createAccessor.

Build a 'nested' accessor for the given message.

Parameters

message:Message<?>: the message to build a new accessor for

Returns:MessageHeaderAccessor

the nested accessor (typically a specific subclass)

Annotations

@Override

createForHeartbeat	back to summary
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.

getAcceptVersion	back to summary
public Set<String> getAcceptVersion()

getAck	back to summary
public String getAck() Annotations @Nullable

getCommand back to summary

getCommand	back to summary
public StompCommand getCommand() Return the STOMP command, or `null` if not yet set. Annotations @Nullable

public StompCommand getCommand()

Return the STOMP command, or null if not yet set.

Annotations

@Nullable

getCommand back to summary

getCommand	back to summary
public static StompCommand getCommand(Map<String, Object> headers) Return the STOMP command from the given headers, or `null` if not set. Annotations @Nullable

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

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

Annotations

@Nullable

getContentLength	back to summary
public Integer getContentLength() Annotations @Nullable

getContentLength	back to summary
public static Integer getContentLength(Map<String, List<String>> nativeHeaders) Annotations @Nullable

getDetailedLogMessage	back to summary
public String getDetailedLogMessage(Object payload) Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.getDetailedLogMessage. Doc from org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage. Return a more detailed message for logging purposes. Parameters payload:Object the payload that corresponds to the headers. Returns:String the message Annotations @Override

getDetailedLogMessage

back to summary

public String getDetailedLogMessage(Object payload)

Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.getDetailedLogMessage.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage.

Return a more detailed message for logging purposes.

Parameters

payload:Object: the payload that corresponds to the headers.

Returns:String

the message

Annotations

@Override

getHeartbeat	back to summary
public long[] getHeartbeat()

getHost	back to summary
public String getHost() Annotations @Nullable

getLogin	back to summary
public String getLogin() Annotations @Nullable

getMessage	back to summary
public String getMessage() Annotations @Nullable

getMessageId	back to summary
public String getMessageId() Annotations @Nullable

getNack	back to summary
public String getNack() Annotations @Nullable

getNativeHeaders	back to summary
protected Map<String, List<String>> getNativeHeaders() Overrides org.springframework.messaging.support.NativeMessageHeaderAccessor.getNativeHeaders. Doc from org.springframework.messaging.support.NativeMessageHeaderAccessor.getNativeHeaders. Subclasses can use this method to access the "native" headers sub-map. Annotations @Override @Nullable

getNativeHeaders

back to summary

protected Map<String, List<String>> getNativeHeaders()

Overrides org.springframework.messaging.support.NativeMessageHeaderAccessor.getNativeHeaders.

Doc from org.springframework.messaging.support.NativeMessageHeaderAccessor.getNativeHeaders.

Subclasses can use this method to access the "native" headers sub-map.

Annotations

@Override
@Nullable

getPasscode back to summary

getPasscode	back to summary
public String getPasscode() Return the passcode header value, or `null` if not set. Annotations @Nullable

public String getPasscode()

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

Annotations

@Nullable

getPasscode back to summary

getPasscode	back to summary
public static String getPasscode(Map<String, Object> headers) Return the passcode header value, or `null` if not set. Annotations @Nullable

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

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

Annotations

@Nullable

getReceipt	back to summary
public String getReceipt() Annotations @Nullable

getReceiptId	back to summary
public String getReceiptId() Annotations @Nullable

getShortLogMessage

back to summary

public String getShortLogMessage(Object payload)

Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.getShortLogMessage.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage.

Return a concise message for logging purposes.

Parameters

payload:Object: the payload that corresponds to the headers.

Returns:String

the message

Annotations

@Override

getVersion	back to summary
public String getVersion() Annotations @Nullable

isHeartbeat	back to summary
public boolean isHeartbeat()

protectPasscode	back to summary
private void protectPasscode()

setAcceptVersion	back to summary
public void setAcceptVersion(String acceptVersion)

setAck	back to summary
public void setAck(String ack)

setContentLength	back to summary
public void setContentLength(int contentLength)

setContentType

back to summary

public void setContentType(MimeType contentType)

Overrides org.springframework.messaging.support.MessageHeaderAccessor.setContentType.

Annotations

@Override

setDestination

back to summary

public void setDestination(String destination)

Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.setDestination.

Annotations

@Override

setHeartbeat	back to summary
public void setHeartbeat(long cx, long cy)

setHost	back to summary
public void setHost(String host)

setLogin	back to summary
public void setLogin(String login)

setMessage	back to summary
public void setMessage(String content)

setMessageId	back to summary
public void setMessageId(String id)

setNack	back to summary
public void setNack(String nack)

setPasscode	back to summary
public void setPasscode(String passcode)

setReceipt	back to summary
public void setReceipt(String receiptId)

setReceiptId	back to summary
public void setReceiptId(String receiptId)

setSubscriptionId

back to summary

public void setSubscriptionId(String subscriptionId)

Overrides org.springframework.messaging.simp.SimpMessageHeaderAccessor.setSubscriptionId.

Annotations

@Override

setVersion	back to summary
public void setVersion(String version)

trySetStompHeaderForSubscriptionId	back to summary
private void trySetStompHeaderForSubscriptionId()

updateSimpMessageHeadersFromStompHeaders	back to summary
pack-priv void updateSimpMessageHeadersFromStompHeaders()

updateStompCommandAsClientMessage	back to summary
public StompCommand updateStompCommandAsClientMessage()

updateStompCommandAsServerMessage	back to summary
public void updateStompCommandAsServerMessage()

updateStompHeadersFromSimpMessageHeaders	back to summary
pack-priv void updateStompHeadersFromSimpMessageHeaders()

wrap

back to summary

public static StompHeaderAccessor wrap(Message<?> message)

Hides org.springframework.messaging.simp.SimpMessageHeaderAccessor.wrap.

Create an instance from the payload and headers of the given Message.

public Class StompHeaderAccessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StompHeaderAccessor.StompPasscode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail