Class StompHeaders

java.lang.Object

org.springframework.messaging.simp.stomp.StompHeaders

All Implemented Interfaces:

Serializable, Map<String, List<String>>, MultiValueMap<String,String>

public class StompHeaders
extends Object
implements MultiValueMap<String,String>, Serializable

Represents STOMP frame headers.

In addition to the normal methods defined by Map, this class offers the following convenience methods:

• getFirst(String) return the first value for a header name
• add(String, String) add to the list of values for a header name
• set(String, String) set a header name to a single string value

Since:

4.2

Author:

Rossen Stoyanchev

See Also:

• https://stomp.github.io/stomp-specification-1.2.html#Frames_and_Headers
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_VERSION
static final String	ACK
static final String	CONTENT_LENGTH
static final String	CONTENT_TYPE
static final String	DESTINATION
static final String	HEARTBEAT
static final String	HOST
static final String	ID
static final String	LOGIN
static final String	MESSAGE_ID
static final String	PASSCODE
static final String	RECEIPT
static final String	RECEIPT_ID
static final String	SERVER
static final String	SESSION
static final String	SUBSCRIPTION

Constructor Summary

Constructors

Constructor	Description
StompHeaders()	Create a new instance to be populated with new header values.

Method Summary

Modifier and Type	Method	Description
void	add(String headerName, @Nullable String headerValue)	Add the given, single header value under the given name.
void	addAll(String headerName, List<? extends String> headerValues)	Add all the values of the given list to the current list of values for the given key.
void	addAll(MultiValueMap<String,String> values)	Add all the values of the given MultiValueMap to the current values.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String, List<String>>>	entrySet()
boolean	equals(@Nullable Object other)
@Nullable List<String>	get(Object key)
String @Nullable []	getAcceptVersion()	Get the accept-version header.
@Nullable String	getAck()	Get the ack header.
long	getContentLength()	Return the content-length header or -1 if unknown.
@Nullable MimeType	getContentType()	Return the content-type header value.
@Nullable String	getDestination()	Get the destination header.
@Nullable String	getFirst(String headerName)	Return the first header value for the given header name, if any.
long @Nullable []	getHeartbeat()	Get the heartbeat header.
@Nullable String	getHost()	Get the host header.
@Nullable String	getId()	Get the id header.
@Nullable String	getLogin()	Get the login header.
@Nullable String	getMessageId()	Get the message-id header.
@Nullable String	getPasscode()	Get the passcode header.
@Nullable String	getReceipt()	Get the receipt header.
@Nullable String	getReceiptId()	Get the receipt header.
@Nullable String	getServer()	Get the server header.
@Nullable String	getSession()	Get the session header.
@Nullable String	getSubscription()	Get the subscription header.
int	hashCode()
boolean	isEmpty()
boolean	isHeartbeatEnabled()	Whether heartbeats are enabled.
Set<String>	keySet()
List<String>	put(String key, List<String> value)
void	putAll(Map<? extends String, ? extends List<String>> map)
static StompHeaders	readOnlyStompHeaders(@Nullable Map<String, List<String>> headers)	Return a StompHeaders object that can only be read, not written to.
List<String>	remove(Object key)
void	set(String headerName, @Nullable String headerValue)	Set the given, single header value under the given name.
void	setAcceptVersion(String @Nullable ... acceptVersions)	Set the accept-version header.
void	setAck(@Nullable String ack)	Set the ack header to one of "auto", "client", or "client-individual".
void	setAll(Map<String,String> values)	Set the given values under.
void	setContentLength(long contentLength)	Set the content-length header.
void	setContentType(@Nullable MimeType mimeType)	Set the content-type header.
void	setDestination(@Nullable String destination)	Set the destination header.
void	setHeartbeat(long @Nullable [] heartbeat)	Set the heartbeat header.
void	setHost(@Nullable String host)	Set the host header.
void	setId(@Nullable String id)	Set the id header.
void	setLogin(@Nullable String login)	Set the login header.
void	setMessageId(@Nullable String messageId)	Set the message-id header.
void	setPasscode(@Nullable String passcode)	Set the passcode header.
void	setReceipt(@Nullable String receipt)	Set the receipt header.
void	setReceiptId(@Nullable String receiptId)	Set the receipt-id header.
void	setServer(@Nullable String server)	Set the server header.
void	setSession(@Nullable String session)	Set the session header.
void	setSubscription(@Nullable String subscription)	Set the login header.
int	size()
Map<String,String>	toSingleValueMap()	Return a Map with the first values contained in this MultiValueMap.
String	toString()
Collection<List<String>>	values()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MultiValueMap

addIfAbsent, asSingleValueMap

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

• Constant Field Values

RECEIPT

public static final String RECEIPT

See Also:

• Constant Field Values

HOST

public static final String HOST

See Also:

• Constant Field Values

ACCEPT_VERSION

public static final String ACCEPT_VERSION

See Also:

• Constant Field Values

LOGIN

public static final String LOGIN

See Also:

• Constant Field Values

PASSCODE

public static final String PASSCODE

See Also:

• Constant Field Values

HEARTBEAT

public static final String HEARTBEAT

See Also:

• Constant Field Values

SESSION

public static final String SESSION

See Also:

• Constant Field Values

SERVER

public static final String SERVER

See Also:

• Constant Field Values

DESTINATION

public static final String DESTINATION

See Also:

• Constant Field Values

ID

public static final String ID

See Also:

• Constant Field Values

ACK

public static final String ACK

See Also:

• Constant Field Values

SUBSCRIPTION

public static final String SUBSCRIPTION

See Also:

• Constant Field Values

MESSAGE_ID

public static final String MESSAGE_ID

See Also:

• Constant Field Values

RECEIPT_ID

public static final String RECEIPT_ID

See Also:

• Constant Field Values

Constructor Details

StompHeaders

public StompHeaders()

Create a new instance to be populated with new header values.

Method Details

setContentType

public void setContentType(@Nullable MimeType mimeType)

Set the content-type header. Applies to the SEND, MESSAGE, and ERROR frames.

getContentType

public @Nullable MimeType getContentType()

Return the content-type header value.

setContentLength

public void setContentLength(long contentLength)

Set the content-length header. Applies to the SEND, MESSAGE, and ERROR frames.

getContentLength

public long getContentLength()

Return the content-length header or -1 if unknown.

setReceipt

public void setReceipt(@Nullable String receipt)

Set the receipt header. Applies to any client frame other than CONNECT.

getReceipt

public @Nullable String getReceipt()

Get the receipt header.

setHost

public void setHost(@Nullable String host)

Set the host header. Applies to the CONNECT frame.

getHost

public @Nullable String getHost()

Get the host header.

setAcceptVersion

public void setAcceptVersion(String @Nullable ... acceptVersions)

Set the accept-version header. Must be one of "1.1", "1.2", or both. Applies to the CONNECT frame.

Since:

5.0.7

getAcceptVersion

public String @Nullable [] getAcceptVersion()

Get the accept-version header.

Since:

5.0.7

setLogin

public void setLogin(@Nullable String login)

Set the login header. Applies to the CONNECT frame.

getLogin

public @Nullable String getLogin()

Get the login header.

setPasscode

public void setPasscode(@Nullable String passcode)

Set the passcode header. Applies to the CONNECT frame.

getPasscode

public @Nullable String getPasscode()

Get the passcode header.

setHeartbeat

public void setHeartbeat(long @Nullable [] heartbeat)

Set the heartbeat header. Applies to the CONNECT and CONNECTED frames.

getHeartbeat

public long @Nullable [] getHeartbeat()

Get the heartbeat header.

isHeartbeatEnabled

public boolean isHeartbeatEnabled()

Whether heartbeats are enabled. Returns false if setHeartbeat(long[]) is set to "0,0", and true otherwise.

setSession

public void setSession(@Nullable String session)

Set the session header. Applies to the CONNECTED frame.

getSession

public @Nullable String getSession()

Get the session header.

setServer

public void setServer(@Nullable String server)

Set the server header. Applies to the CONNECTED frame.

getServer

public @Nullable String getServer()

Get the server header. Applies to the CONNECTED frame.

setDestination

public void setDestination(@Nullable String destination)

Set the destination header.

getDestination

public @Nullable String getDestination()

Get the destination header. Applies to the SEND, SUBSCRIBE, and MESSAGE frames.

setId

public void setId(@Nullable String id)

Set the id header. Applies to the SUBSCR0BE, UNSUBSCRIBE, and ACK or NACK frames.

getId

public @Nullable String getId()

Get the id header.

setAck

public void setAck(@Nullable String ack)

Set the ack header to one of "auto", "client", or "client-individual". Applies to the SUBSCRIBE and MESSAGE frames.

getAck

public @Nullable String getAck()

Get the ack header.

setSubscription

public void setSubscription(@Nullable String subscription)

Set the login header. Applies to the MESSAGE frame.

getSubscription

public @Nullable String getSubscription()

Get the subscription header.

setMessageId

public void setMessageId(@Nullable String messageId)

Set the message-id header. Applies to the MESSAGE frame.

getMessageId

public @Nullable String getMessageId()

Get the message-id header.

setReceiptId

public void setReceiptId(@Nullable String receiptId)

Set the receipt-id header. Applies to the RECEIPT frame.

getReceiptId

public @Nullable String getReceiptId()

Get the receipt header.

getFirst

public @Nullable String getFirst(String headerName)

Return the first header value for the given header name, if any.

Specified by:

getFirst in interface MultiValueMap<String,String>

Parameters:

headerName - the header name

Returns:

the first header value, or null if none

add

public void add(String headerName,
 @Nullable String headerValue)

Add the given, single header value under the given name.

Specified by:

add in interface MultiValueMap<String,String>

Parameters:

headerName - the header name

headerValue - the header value

Throws:

UnsupportedOperationException - if adding headers is not supported

See Also:

• put(String, List)
• set(String, String)

addAll

public void addAll(String headerName,
 List<? extends String> headerValues)

Description copied from interface: MultiValueMap

Add all the values of the given list to the current list of values for the given key.

Specified by:

addAll in interface MultiValueMap<String,String>

Parameters:

headerName - they key

headerValues - the values to be added

addAll

public void addAll(MultiValueMap<String,String> values)

Description copied from interface: MultiValueMap

Add all the values of the given MultiValueMap to the current values.

Specified by:

addAll in interface MultiValueMap<String,String>

Parameters:

values - the values to be added

set

public void set(String headerName,
 @Nullable String headerValue)

Set the given, single header value under the given name.

Specified by:

set in interface MultiValueMap<String,String>

Parameters:

headerName - the header name

headerValue - the header value

Throws:

UnsupportedOperationException - if adding headers is not supported

See Also:

• put(String, List)
• add(String, String)

setAll

public void setAll(Map<String,String> values)

Description copied from interface: MultiValueMap

Set the given values under.

Specified by:

setAll in interface MultiValueMap<String,String>

Parameters:

values - the values.

toSingleValueMap

public Map<String,String> toSingleValueMap()

Description copied from interface: MultiValueMap

Return a Map with the first values contained in this MultiValueMap. The difference between this method and MultiValueMap.asSingleValueMap() is that this method returns a copy of the entries of this map, whereas the latter returns a view.

Specified by:

toSingleValueMap in interface MultiValueMap<String,String>

Returns:

a single value representation of this map

size

public int size()

Specified by:

size in interface Map<String, List<String>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String, List<String>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String, List<String>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String, List<String>>

get

public @Nullable List<String> get(Object key)

Specified by:

get in interface Map<String, List<String>>

put

public List<String> put(String key,
 List<String> value)

Specified by:

put in interface Map<String, List<String>>

remove

public List<String> remove(Object key)

Specified by:

remove in interface Map<String, List<String>>

putAll

public void putAll(Map<? extends String, ? extends List<String>> map)

Specified by:

putAll in interface Map<String, List<String>>

clear

public void clear()

Specified by:

clear in interface Map<String, List<String>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String, List<String>>

values

public Collection<List<String>> values()

Specified by:

values in interface Map<String, List<String>>

entrySet

public Set<Map.Entry<String, List<String>>> entrySet()

Specified by:

entrySet in interface Map<String, List<String>>

equals

public boolean equals(@Nullable Object other)

Specified by:

equals in interface Map<String, List<String>>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String, List<String>>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

readOnlyStompHeaders

public static StompHeaders readOnlyStompHeaders(@Nullable Map<String, List<String>> headers)

Return a StompHeaders object that can only be read, not written to.