org.springframework.integration.message
Class MessageHeader

java.lang.Object
  org.springframework.integration.message.MessageHeader

public class MessageHeader
extends java.lang.Object

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

Constructor Summary

MessageHeader()

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() Return the expiration date for this message or null to indicate 'never expire'.
java.lang.String	getProperty(java.lang.String key)
java.util.Set<java.lang.String>	getPropertyNames()
java.lang.String	getReplyChannelName()
int	getSequenceNumber()
int	getSequenceSize()
java.util.Date	getTimestamp() Return the creation time of this message.
void	setAttribute(java.lang.String key, java.lang.Object value)
void	setCorrelationId(java.lang.Object correlationId)
void	setExpiration(java.util.Date expiration) Set the expiration date for this message or null to indicate 'never expire'.
void	setProperty(java.lang.String key, java.lang.String value)
void	setReplyChannelName(java.lang.String replyChannelName)
void	setSequenceNumber(int sequenceNumber)
void	setSequenceSize(int sequenceSize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageHeader

public MessageHeader()

Method Detail

getTimestamp

public java.util.Date getTimestamp()

Return the creation time of this message.

getExpiration

public java.util.Date getExpiration()

Return the expiration date for this message or null to indicate 'never expire'.

setExpiration

public void setExpiration(java.util.Date expiration)

Set the expiration date for this message or null to indicate 'never expire'. The default is null.

getCorrelationId

public java.lang.Object getCorrelationId()

setCorrelationId

public void setCorrelationId(java.lang.Object correlationId)

getReplyChannelName

public java.lang.String getReplyChannelName()

setReplyChannelName

public void setReplyChannelName(java.lang.String replyChannelName)

getSequenceNumber

public int getSequenceNumber()

setSequenceNumber

public void setSequenceNumber(int sequenceNumber)

getSequenceSize

public int getSequenceSize()

setSequenceSize

public void setSequenceSize(int sequenceSize)

getProperty

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

setProperty

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

getPropertyNames

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

getAttribute

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

setAttribute

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

getAttributeNames

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