org.springframework.integration.message
Interface MessageHeader

All Known Implementing Classes:

DefaultMessageHeader

public interface MessageHeader

A holder for Message metadata. This includes information that may be used by the messaging system (such as correlationId) as well as information that is relevant for specific messaging endpoints. For the latter, String values may be stored as properties and Object values may be stored as attributes.

Author:

Mark Fisher

Method Summary

java.lang.Object	getAttribute(java.lang.String key)
java.util.Set<java.lang.String>	getAttributeNames()
java.lang.Object	getCorrelationId()
java.util.Date	getExpiration()
MessagePriority	getPriority()
java.lang.String	getProperty(java.lang.String key)
java.util.Set<java.lang.String>	getPropertyNames()
java.lang.Object	getReturnAddress()
int	getSequenceNumber()
int	getSequenceSize()
java.util.Date	getTimestamp()
java.lang.Object	removeAttribute(java.lang.String key)
java.lang.String	removeProperty(java.lang.String key)
java.lang.Object	setAttribute(java.lang.String key, java.lang.Object value)
java.lang.Object	setAttributeIfAbsent(java.lang.String key, java.lang.Object value)
void	setCorrelationId(java.lang.Object correlationId)
void	setExpiration(java.util.Date expiration)
void	setPriority(MessagePriority priority)
java.lang.String	setProperty(java.lang.String key, java.lang.String value)
void	setReturnAddress(java.lang.Object returnAddress)
void	setSequenceNumber(int sequenceNumber)
void	setSequenceSize(int sequenceSize)

Method Detail

getTimestamp

java.util.Date getTimestamp()

getExpiration

java.util.Date getExpiration()

setExpiration

void setExpiration(java.util.Date expiration)

getCorrelationId

java.lang.Object getCorrelationId()

setCorrelationId

void setCorrelationId(java.lang.Object correlationId)

getReturnAddress

java.lang.Object getReturnAddress()

setReturnAddress

void setReturnAddress(java.lang.Object returnAddress)

getSequenceNumber

int getSequenceNumber()

setSequenceNumber

void setSequenceNumber(int sequenceNumber)

getSequenceSize

int getSequenceSize()

setSequenceSize

void setSequenceSize(int sequenceSize)

getPriority

MessagePriority getPriority()

setPriority

void setPriority(MessagePriority priority)

getProperty

java.lang.String getProperty(java.lang.String key)

setProperty

java.lang.String setProperty(java.lang.String key,
                             java.lang.String value)

removeProperty

java.lang.String removeProperty(java.lang.String key)

getPropertyNames

java.util.Set<java.lang.String> getPropertyNames()

getAttribute

java.lang.Object getAttribute(java.lang.String key)

setAttribute

java.lang.Object setAttribute(java.lang.String key,
                              java.lang.Object value)

setAttributeIfAbsent

java.lang.Object setAttributeIfAbsent(java.lang.String key,
                                      java.lang.Object value)

removeAttribute

java.lang.Object removeAttribute(java.lang.String key)

getAttributeNames

java.util.Set<java.lang.String> getAttributeNames()