MessageHeaders (Spring Integration 3.0.7.RELEASE API)

java.lang.Object
- org.springframework.integration.MessageHeaders

All Implemented Interfaces:

Serializable, Map<String,Object>
```
public final class MessageHeaders
extends Object
implements Map<String,Object>, Serializable
```
The headers for a Message.
IMPORTANT: MessageHeaders are immutable. Any mutating operation (e.g., put(..), putAll(..) etc.) will result in UnsupportedOperationException To create MessageHeaders instance use fluent MessageBuilder API
```
 MessageBuilder.withPayload("foo").setHeader("key1", "value1").setHeader("key2", "value2");
 
```
or create an instance of GenericMessage passing payload as Object and headers as a regular Map
```
 Map headers = new HashMap();
 headers.put("key1", "value1");
 headers.put("key2", "value2");
 new GenericMessage("foo", headers);
 
```
Author:

Arjen Poutsma, Mark Fisher, Oleg Zhurakousky, Gary Russell, Rossen Stoyanchev

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageHeaders.AlternativeJdkIdGenerator` A variation of `UUID.randomUUID()` that uses `SecureRandom` only for the initial seed and `Random` thereafter, which provides better performance in exchange for less securely random id's.
`static interface`	`MessageHeaders.IdGenerator`
`static class`	`MessageHeaders.JdkIdGenerator`
`static class`	`MessageHeaders.SimpleIncrementingIdGenerator`

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_TYPE`
`static String`	`CORRELATION_ID`
`static String`	`ERROR_CHANNEL`
`static String`	`EXPIRATION_DATE`
`static String`	`ID` The key for the Message ID.
`static String`	`POSTPROCESS_RESULT`
`static String`	`PRIORITY`
`static String`	`REPLY_CHANNEL`
`static String`	`SEQUENCE_DETAILS`
`static String`	`SEQUENCE_NUMBER`
`static String`	`SEQUENCE_SIZE`
`static String`	`TIMESTAMP`

Constructor Summary

Constructors
Constructor and Description

MessageHeaders(Map<String,Object> headers)

Constructors
Constructor and Description
`MessageHeaders(Map<String,Object> headers)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Since MessageHeaders are immutable the call to this method will result in `UnsupportedOperationException`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object object)`
`Object`	`get(Object key)`
`<T> T`	`get(Object key, Class<T> type)`
`Object`	`getCorrelationId()`
`Object`	`getErrorChannel()`
`Long`	`getExpirationDate()`
`UUID`	`getId()`
`Integer`	`getPriority()`
`Object`	`getReplyChannel()`
`Integer`	`getSequenceNumber()`
`Integer`	`getSequenceSize()`
`Long`	`getTimestamp()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`Object`	`put(String key, Object value)` Since MessageHeaders are immutable the call to this method will result in `UnsupportedOperationException`
`void`	`putAll(Map<? extends String,? extends Object> t)` Since MessageHeaders are immutable the call to this method will result in `UnsupportedOperationException`
`Object`	`remove(Object key)` Since MessageHeaders are immutable the call to this method will result in `UnsupportedOperationException`
`int`	`size()`
`String`	`toString()`
`Collection<Object>`	`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
  - ID
```
public static final String ID
```
    The key for the Message ID. This is an automatically generated UUID and should never be explicitly set in the header map except in the case of Message deserialization where the serialized Message's generated UUID is being restored.
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP
```
public static final String TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - CORRELATION_ID
```
public static final String CORRELATION_ID
```
    See Also:
    
    Constant Field Values
  - REPLY_CHANNEL
```
public static final String REPLY_CHANNEL
```
    See Also:
    
    Constant Field Values
  - ERROR_CHANNEL
```
public static final String ERROR_CHANNEL
```
    See Also:
    
    Constant Field Values
  - EXPIRATION_DATE
```
public static final String EXPIRATION_DATE
```
    See Also:
    
    Constant Field Values
  - PRIORITY
```
public static final String PRIORITY
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_NUMBER
```
public static final String SEQUENCE_NUMBER
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_SIZE
```
public static final String SEQUENCE_SIZE
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_DETAILS
```
public static final String SEQUENCE_DETAILS
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - POSTPROCESS_RESULT
```
public static final String POSTPROCESS_RESULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessageHeaders
```
public MessageHeaders(Map<String,Object> headers)
```
- Method Detail
  - getId
```
public UUID getId()
```
  - getTimestamp
```
public Long getTimestamp()
```
  - getExpirationDate
```
public Long getExpirationDate()
```
  - getCorrelationId
```
public Object getCorrelationId()
```
  - getReplyChannel
```
public Object getReplyChannel()
```
  - getErrorChannel
```
public Object getErrorChannel()
```
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
  - getSequenceSize
```
public Integer getSequenceSize()
```
  - getPriority
```
public Integer getPriority()
```
  - get
```
public <T> T get(Object key,
                 Class<T> type)
```
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,Object>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Specified by:
    
    equals in interface Map<String,Object>
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,Object>
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<String,Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<String,Object>
  - put
```
public Object put(String key,
                  Object value)
```
    Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
    
    Specified by:
    
    put in interface Map<String,Object>
  - putAll
```
public void putAll(Map<? extends String,? extends Object> t)
```
    Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
    
    Specified by:
    
    putAll in interface Map<String,Object>
  - remove
```
public Object remove(Object key)
```
    Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
    
    Specified by:
    
    remove in interface Map<String,Object>
  - clear
```
public void clear()
```
    Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
    
    Specified by:
    
    clear in interface Map<String,Object>

Class MessageHeaders

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

ID

TIMESTAMP

CORRELATION_ID

REPLY_CHANNEL

ERROR_CHANNEL

EXPIRATION_DATE

PRIORITY

SEQUENCE_NUMBER

SEQUENCE_SIZE

SEQUENCE_DETAILS

CONTENT_TYPE

POSTPROCESS_RESULT

Constructor Detail

MessageHeaders

Method Detail

getId

getTimestamp

getExpirationDate

getCorrelationId

getReplyChannel

getErrorChannel

getSequenceNumber

getSequenceSize

getPriority

get

hashCode

equals

toString

containsKey

containsValue

entrySet

get

isEmpty

keySet

size

values

put

putAll

remove

clear