org.springframework.integration
Class MessageHeaders

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

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public final class MessageHeaders
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.Object>, java.io.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

See Also:

Serialized Form

Nested Class Summary

static interface

MessageHeaders.IdGenerator

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

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	CORRELATION_ID
static java.lang.String	ERROR_CHANNEL
static java.lang.String	EXPIRATION_DATE
static java.lang.String	ID The key for the Message ID.
static java.lang.String	PRIORITY
static java.lang.String	REPLY_CHANNEL
static java.lang.String	SEQUENCE_DETAILS
static java.lang.String	SEQUENCE_NUMBER
static java.lang.String	SEQUENCE_SIZE
static java.lang.String	TIMESTAMP

Constructor Summary

MessageHeaders(java.util.Map<java.lang.String,java.lang.Object> headers)

Method Summary

void	clear() Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
boolean	equals(java.lang.Object obj)
java.lang.Object	get(java.lang.Object key)
<T> T	get(java.lang.Object key, java.lang.Class<T> type)
java.lang.Object	getCorrelationId()
java.lang.Object	getErrorChannel()
java.lang.Long	getExpirationDate()
java.util.UUID	getId()
java.lang.Integer	getPriority()
java.lang.Object	getReplyChannel()
java.lang.Integer	getSequenceNumber()
java.lang.Integer	getSequenceSize()
java.lang.Long	getTimestamp()
int	hashCode()
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.Object	put(java.lang.String key, java.lang.Object value) Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> t) Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
java.lang.Object	remove(java.lang.Object key) Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException
int	size()
java.lang.String	toString()
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.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 java.lang.String TIMESTAMP

See Also:

Constant Field Values

CORRELATION_ID

public static final java.lang.String CORRELATION_ID

See Also:

Constant Field Values

REPLY_CHANNEL

public static final java.lang.String REPLY_CHANNEL

See Also:

Constant Field Values

ERROR_CHANNEL

public static final java.lang.String ERROR_CHANNEL

See Also:

Constant Field Values

EXPIRATION_DATE

public static final java.lang.String EXPIRATION_DATE

See Also:

Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY

See Also:

Constant Field Values

SEQUENCE_NUMBER

public static final java.lang.String SEQUENCE_NUMBER

See Also:

Constant Field Values

SEQUENCE_SIZE

public static final java.lang.String SEQUENCE_SIZE

See Also:

Constant Field Values

SEQUENCE_DETAILS

public static final java.lang.String SEQUENCE_DETAILS

See Also:

Constant Field Values

Constructor Detail

MessageHeaders

public MessageHeaders(java.util.Map<java.lang.String,java.lang.Object> headers)

Method Detail

getId

public java.util.UUID getId()

getTimestamp

public java.lang.Long getTimestamp()

getExpirationDate

public java.lang.Long getExpirationDate()

getCorrelationId

public java.lang.Object getCorrelationId()

getReplyChannel

public java.lang.Object getReplyChannel()

getErrorChannel

public java.lang.Object getErrorChannel()

getSequenceNumber

public java.lang.Integer getSequenceNumber()

getSequenceSize

public java.lang.Integer getSequenceSize()

getPriority

public java.lang.Integer getPriority()

get

public <T> T get(java.lang.Object key,
                 java.lang.Class<T> type)

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> t)

Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

clear

public void clear()

Since MessageHeaders are immutable the call to this method will result in UnsupportedOperationException

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>