org.springframework.messaging.simp.stomp

Class StompHeaderAccessor

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.

Since:

4.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COMMAND_HEADER
private static java.lang.String	CREDENTIALS_HEADER
private static long[]	DEFAULT_HEARTBEAT
private static java.util.concurrent.atomic.AtomicLong	messageIdCounter
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

Fields inherited from class 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

Fields inherited from class org.springframework.messaging.support.NativeMessageHeaderAccessor

NATIVE_HEADERS

Fields inherited from class org.springframework.messaging.support.MessageHeaderAccessor

DEFAULT_CHARSET

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private java.lang.String	appendPayload(java.lang.Object payload)
private java.lang.String	appendSession()
static StompHeaderAccessor	create(StompCommand command) Create an instance for the given STOMP command.
static StompHeaderAccessor	create(StompCommand command, java.util.Map<java.lang.String,java.util.List<java.lang.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.
java.util.Set<java.lang.String>	getAcceptVersion()
java.lang.String	getAck()
StompCommand	getCommand() Return the STOMP command, or null if not yet set.
static StompCommand	getCommand(java.util.Map<java.lang.String,java.lang.Object> headers) Return the STOMP command from the given headers, or null if not set.
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) Return a more detailed message for logging purposes.
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() Return the passcode header value, or null if not set.
static java.lang.String	getPasscode(java.util.Map<java.lang.String,java.lang.Object> headers) Return the passcode header value, or null if not set.
java.lang.String	getReceipt()
java.lang.String	getReceiptId()
java.lang.String	getShortLogMessage(java.lang.Object payload) Return a concise message for logging purposes.
java.lang.String	getVersion()
boolean	isHeartbeat()
private void	protectPasscode()
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)
private void	trySetStompHeaderForSubscriptionId()
(package private) void	updateSimpMessageHeadersFromStompHeaders()
StompCommand	updateStompCommandAsClientMessage()
void	updateStompCommandAsServerMessage()
(package private) void	updateStompHeadersFromSimpMessageHeaders()
static StompHeaderAccessor	wrap(Message<?> message) Create an instance from the payload and headers of the given Message.

Methods inherited from class org.springframework.messaging.simp.SimpMessageHeaderAccessor

create, create, getDestination, getDestination, getHeartbeat, getMessageType, getMessageType, getSessionAttributes, getSessionAttributes, getSessionId, getSessionId, getSubscriptionId, getSubscriptionId, getUser, getUser, setMessageTypeIfNotSet, setSessionAttributes, setSessionId, setUser

Methods inherited from class org.springframework.messaging.support.NativeMessageHeaderAccessor

addNativeHeader, addNativeHeaders, containsNativeHeader, getFirstNativeHeader, getFirstNativeHeader, getNativeHeader, removeNativeHeader, setImmutable, setNativeHeader, toNativeHeaderMap

Methods inherited from class 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

messageIdCounter

private static final java.util.concurrent.atomic.AtomicLong messageIdCounter

DEFAULT_HEARTBEAT

private static final long[] DEFAULT_HEARTBEAT

STOMP_ID_HEADER

public static final java.lang.String STOMP_ID_HEADER

See Also:

Constant Field Values

STOMP_HOST_HEADER

public static final java.lang.String STOMP_HOST_HEADER

See Also:

Constant Field Values

STOMP_ACCEPT_VERSION_HEADER

public static final java.lang.String STOMP_ACCEPT_VERSION_HEADER

See Also:

Constant Field Values

STOMP_MESSAGE_ID_HEADER

public static final java.lang.String STOMP_MESSAGE_ID_HEADER

See Also:

Constant Field Values

STOMP_RECEIPT_HEADER

public static final java.lang.String STOMP_RECEIPT_HEADER

See Also:

Constant Field Values

STOMP_RECEIPT_ID_HEADER

public static final java.lang.String STOMP_RECEIPT_ID_HEADER

See Also:

Constant Field Values

STOMP_SUBSCRIPTION_HEADER

public static final java.lang.String STOMP_SUBSCRIPTION_HEADER

See Also:

Constant Field Values

STOMP_VERSION_HEADER

public static final java.lang.String STOMP_VERSION_HEADER

See Also:

Constant Field Values

STOMP_MESSAGE_HEADER

public static final java.lang.String STOMP_MESSAGE_HEADER

See Also:

Constant Field Values

STOMP_ACK_HEADER

public static final java.lang.String STOMP_ACK_HEADER

See Also:

Constant Field Values

STOMP_NACK_HEADER

public static final java.lang.String STOMP_NACK_HEADER

See Also:

Constant Field Values

STOMP_LOGIN_HEADER

public static final java.lang.String STOMP_LOGIN_HEADER

See Also:

Constant Field Values

STOMP_PASSCODE_HEADER

public static final java.lang.String STOMP_PASSCODE_HEADER

See Also:

Constant Field Values

STOMP_DESTINATION_HEADER

public static final java.lang.String STOMP_DESTINATION_HEADER

See Also:

Constant Field Values

STOMP_CONTENT_TYPE_HEADER

public static final java.lang.String STOMP_CONTENT_TYPE_HEADER

See Also:

Constant Field Values

STOMP_CONTENT_LENGTH_HEADER

public static final java.lang.String STOMP_CONTENT_LENGTH_HEADER

See Also:

Constant Field Values

STOMP_HEARTBEAT_HEADER

public static final java.lang.String STOMP_HEARTBEAT_HEADER

See Also:

Constant Field Values

COMMAND_HEADER

private static final java.lang.String COMMAND_HEADER

See Also:

Constant Field Values

CREDENTIALS_HEADER

private static final java.lang.String CREDENTIALS_HEADER

See Also:

Constant Field Values

Constructor Detail

StompHeaderAccessor

StompHeaderAccessor(StompCommand command,
                    @Nullable
                    java.util.Map<java.lang.String,java.util.List<java.lang.String>> externalSourceHeaders)

A constructor for creating message headers from a parsed STOMP frame.

StompHeaderAccessor

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 SimpMessageHeaderAccessor.

StompHeaderAccessor

StompHeaderAccessor()

Method Detail

updateSimpMessageHeadersFromStompHeaders

void updateSimpMessageHeadersFromStompHeaders()

updateStompHeadersFromSimpMessageHeaders

void updateStompHeadersFromSimpMessageHeaders()

createAccessor

protected MessageHeaderAccessor createAccessor(Message<?> message)

Description copied from class: MessageHeaderAccessor

Build a 'nested' accessor for the given message.

Overrides:

createAccessor in class SimpMessageHeaderAccessor

Parameters:

message - the message to build a new accessor for

Returns:

the nested accessor (typically a specific subclass)

getNativeHeaders

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

Overrides:

getNativeHeaders in class NativeMessageHeaderAccessor

updateStompCommandAsClientMessage

public StompCommand updateStompCommandAsClientMessage()

updateStompCommandAsServerMessage

public void updateStompCommandAsServerMessage()

getCommand

@Nullable
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(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)

Overrides:

setDestination in class SimpMessageHeaderAccessor

setContentType

public void setContentType(MimeType contentType)

Overrides:

setContentType in class MessageHeaderAccessor

setSubscriptionId

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

Overrides:

setSubscriptionId in class SimpMessageHeaderAccessor

trySetStompHeaderForSubscriptionId

private void trySetStompHeaderForSubscriptionId()

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)

protectPasscode

private void protectPasscode()

getPasscode

@Nullable
public java.lang.String getPasscode()

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

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)

Description copied from class: MessageHeaderAccessor

Return a concise message for logging purposes.

Overrides:

getShortLogMessage in class SimpMessageHeaderAccessor

Parameters:

payload - the payload that corresponds to the headers.

Returns:

the message

getDetailedLogMessage

public java.lang.String getDetailedLogMessage(@Nullable
                                              java.lang.Object payload)

Description copied from class: MessageHeaderAccessor

Return a more detailed message for logging purposes.

Overrides:

getDetailedLogMessage in class SimpMessageHeaderAccessor

Parameters:

payload - the payload that corresponds to the headers.

Returns:

the message

appendSession

private java.lang.String appendSession()

appendPayload

private java.lang.String appendPayload(java.lang.Object payload)

create

public static StompHeaderAccessor create(StompCommand command)

Create an instance for the given STOMP command.

create

public static StompHeaderAccessor create(StompCommand command,
                                         java.util.Map<java.lang.String,java.util.List<java.lang.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

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

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

getPasscode

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

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

getContentLength

@Nullable
public static java.lang.Integer getContentLength(java.util.Map<java.lang.String,java.util.List<java.lang.String>> nativeHeaders)