StompHeaders (Spring Framework 4.3.21.RELEASE API)

java.lang.Object
- org.springframework.messaging.simp.stomp.StompHeaders

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.util.List<java.lang.String>>, MultiValueMap<java.lang.String,java.lang.String>
```
public class StompHeaders
extends java.lang.Object
implements MultiValueMap<java.lang.String,java.lang.String>, java.io.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:

http://stomp.github.io/stomp-specification-1.2.html#Frames_and_Headers, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACK`
`static java.lang.String`	`CONTENT_LENGTH`
`static java.lang.String`	`CONTENT_TYPE`
`static java.lang.String`	`DESTINATION`
`static java.lang.String`	`HEARTBEAT`
`static java.lang.String`	`HOST`
`static java.lang.String`	`ID`
`static java.lang.String`	`LOGIN`
`static java.lang.String`	`MESSAGE_ID`
`static java.lang.String`	`PASSCODE`
`static java.lang.String`	`RECEIPT`
`static java.lang.String`	`RECEIPT_ID`
`static java.lang.String`	`SERVER`
`static java.lang.String`	`SESSION`
`static java.lang.String`	`SUBSCRIPTION`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - CONTENT_TYPE
```
public static final java.lang.String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CONTENT_LENGTH
```
public static final java.lang.String CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - RECEIPT
```
public static final java.lang.String RECEIPT
```
    See Also:
    
    Constant Field Values
  - HOST
```
public static final java.lang.String HOST
```
    See Also:
    
    Constant Field Values
  - LOGIN
```
public static final java.lang.String LOGIN
```
    See Also:
    
    Constant Field Values
  - PASSCODE
```
public static final java.lang.String PASSCODE
```
    See Also:
    
    Constant Field Values
  - HEARTBEAT
```
public static final java.lang.String HEARTBEAT
```
    See Also:
    
    Constant Field Values
  - SESSION
```
public static final java.lang.String SESSION
```
    See Also:
    
    Constant Field Values
  - SERVER
```
public static final java.lang.String SERVER
```
    See Also:
    
    Constant Field Values
  - DESTINATION
```
public static final java.lang.String DESTINATION
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
  - ACK
```
public static final java.lang.String ACK
```
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION
```
public static final java.lang.String SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_ID
```
public static final java.lang.String MESSAGE_ID
```
    See Also:
    
    Constant Field Values
  - RECEIPT_ID
```
public static final java.lang.String RECEIPT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StompHeaders
```
public StompHeaders()
```
    Create a new instance to be populated with new header values.
- Method Detail
  - setContentType
```
public void setContentType(MimeType mimeType)
```
    Set the content-type header. Applies to the SEND, MESSAGE, and ERROR frames.
  - getContentType
```
public 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(java.lang.String receipt)
```
    Set the receipt header. Applies to any client frame other than CONNECT.
  - getReceipt
```
public java.lang.String getReceipt()
```
    Get the receipt header.
  - setHost
```
public void setHost(java.lang.String host)
```
    Set the host header. Applies to the CONNECT frame.
  - getHost
```
public java.lang.String getHost()
```
    Get the host header.
  - setLogin
```
public void setLogin(java.lang.String login)
```
    Set the login header. Applies to the CONNECT frame.
  - getLogin
```
public java.lang.String getLogin()
```
    Get the login header.
  - setPasscode
```
public void setPasscode(java.lang.String passcode)
```
    Set the passcode header. Applies to the CONNECT frame.
  - getPasscode
```
public java.lang.String getPasscode()
```
    Get the passcode header.
  - setHeartbeat
```
public void setHeartbeat(long[] heartbeat)
```
    Set the heartbeat header. Applies to the CONNECT and CONNECTED frames.
  - getHeartbeat
```
public long[] 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(java.lang.String session)
```
    Set the session header. Applies to the CONNECTED frame.
  - getSession
```
public java.lang.String getSession()
```
    Get the session header.
  - setServer
```
public void setServer(java.lang.String server)
```
    Set the server header. Applies to the CONNECTED frame.
  - getServer
```
public java.lang.String getServer()
```
    Get the server header. Applies to the CONNECTED frame.
  - setDestination
```
public void setDestination(java.lang.String destination)
```
    Set the destination header.
  - getDestination
```
public java.lang.String getDestination()
```
    Get the destination header. Applies to the SEND, SUBSCRIBE, and MESSAGE frames.
  - setId
```
public void setId(java.lang.String id)
```
    Set the id header. Applies to the SUBSCR0BE, UNSUBSCRIBE, and ACK or NACK frames.
  - getId
```
public java.lang.String getId()
```
    Get the id header.
  - setAck
```
public void setAck(java.lang.String ack)
```
    Set the ack header to one of "auto", "client", or "client-individual". Applies to the SUBSCRIBE and MESSAGE frames.
  - getAck
```
public java.lang.String getAck()
```
    Get the ack header.
  - setSubscription
```
public void setSubscription(java.lang.String subscription)
```
    Set the login header. Applies to the MESSAGE frame.
  - getSubscription
```
public java.lang.String getSubscription()
```
    Get the subscription header.
  - setMessageId
```
public void setMessageId(java.lang.String messageId)
```
    Set the message-id header. Applies to the MESSAGE frame.
  - getMessageId
```
public java.lang.String getMessageId()
```
    Get the message-id header.
  - setReceiptId
```
public void setReceiptId(java.lang.String receiptId)
```
    Set the receipt-id header. Applies to the RECEIPT frame.
  - getReceiptId
```
public java.lang.String getReceiptId()
```
    Get the receipt header.
  - getFirst
```
public java.lang.String getFirst(java.lang.String headerName)
```
    Return the first header value for the given header name, if any.
    
    Specified by:
    
    getFirst in interface MultiValueMap<java.lang.String,java.lang.String>
    
    Parameters:
    
    headerName - the header name
    
    Returns:
    
    the first header value, or null if none
  - add
```
public void add(java.lang.String headerName,
                java.lang.String headerValue)
```
    Add the given, single header value under the given name.
    
    Specified by:
    
    add in interface MultiValueMap<java.lang.String,java.lang.String>
    
    Parameters:
    
    headerName - the header name
    
    headerValue - the header value
    
    Throws:
    
    java.lang.UnsupportedOperationException - if adding headers is not supported
    
    See Also:
    
    put(String, List), set(String, String)
  - set
```
public void set(java.lang.String headerName,
                java.lang.String headerValue)
```
    Set the given, single header value under the given name.
    
    Specified by:
    
    set in interface MultiValueMap<java.lang.String,java.lang.String>
    
    Parameters:
    
    headerName - the header name
    
    headerValue - the header value
    
    Throws:
    
    java.lang.UnsupportedOperationException - if adding headers is not supported
    
    See Also:
    
    put(String, List), add(String, String)
  - setAll
```
public void setAll(java.util.Map<java.lang.String,java.lang.String> values)
```
    Description copied from interface: MultiValueMap
    
    Set the given values under.
    
    Specified by:
    
    setAll in interface MultiValueMap<java.lang.String,java.lang.String>
    
    Parameters:
    
    values - the values.
  - toSingleValueMap
```
public java.util.Map<java.lang.String,java.lang.String> toSingleValueMap()
```
    Description copied from interface: MultiValueMap
    
    Return a Map with the first values contained in this MultiValueMap.
    
    Specified by:
    
    toSingleValueMap in interface MultiValueMap<java.lang.String,java.lang.String>
    
    Returns:
    
    a single value representation of this map
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - get
```
public java.util.List<java.lang.String> get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - put
```
public java.util.List<java.lang.String> put(java.lang.String key,
                                            java.util.List<java.lang.String> value)
```
    Specified by:
    
    put in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - remove
```
public java.util.List<java.lang.String> remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> map)
```
    Specified by:
    
    putAll in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - values
```
public java.util.Collection<java.util.List<java.lang.String>> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
  - equals
```
public boolean equals(java.lang.Object other)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - readOnlyStompHeaders
```
public static StompHeaders readOnlyStompHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
```
    Return a StompHeaders object that can only be read, not written to.

Class StompHeaders

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

CONTENT_TYPE

CONTENT_LENGTH

RECEIPT

HOST

LOGIN

PASSCODE

HEARTBEAT

SESSION

SERVER

DESTINATION

ID

ACK

SUBSCRIPTION

MESSAGE_ID

RECEIPT_ID

Constructor Detail

StompHeaders

Method Detail

setContentType

getContentType

setContentLength

getContentLength

setReceipt

getReceipt

setHost

getHost

setLogin

getLogin

setPasscode

getPasscode

setHeartbeat

getHeartbeat

isHeartbeatEnabled

setSession

getSession

setServer

getServer

setDestination

getDestination

setId

getId

setAck

getAck

setSubscription

getSubscription

setMessageId

getMessageId

setReceiptId

getReceiptId

getFirst

add

set

setAll

toSingleValueMap

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

toString

readOnlyStompHeaders