org.springframework.messaging.support

Class MessageHeaderAccessor

java.lang.Object

org.springframework.messaging.support.MessageHeaderAccessor

Direct Known Subclasses:

NativeMessageHeaderAccessor

public class MessageHeaderAccessor
extends java.lang.Object

A base class for read/write access to MessageHeaders. Supports creation of new headers or modification of existing message headers.

Sub-classes can provide additional typed getters and setters for convenient access to specific headers. Getters and setters should delegate to getHeader(String) or setHeader(String, Object) respectively. At the end toMap() can be used to obtain the resulting headers.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	headers
protected Log	logger
private MessageHeaders	originalHeaders

Constructor Summary

Constructors

Constructor and Description
MessageHeaderAccessor() A constructor for creating new message headers.
MessageHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers.

Method Summary

Modifier and Type	Method and Description
void	copyHeaders(java.util.Map<java.lang.String,?> headersToCopy) Copy the name-value pairs from the provided Map.
void	copyHeadersIfAbsent(java.util.Map<java.lang.String,?> headersToCopy) Copy the name-value pairs from the provided Map.
MimeType	getContentType()
java.lang.Object	getErrorChannel()
java.lang.Object	getHeader(java.lang.String headerName)
java.util.UUID	getId()
private java.util.List<java.lang.String>	getMatchingHeaderNames(java.lang.String pattern, java.util.Map<java.lang.String,java.lang.Object> headers)
java.lang.Object	getReplyChannel()
java.lang.Long	getTimestamp()
boolean	isModified()
protected boolean	isReadOnly(java.lang.String headerName)
void	removeHeader(java.lang.String headerName) Remove the value for the given header name.
void	removeHeaders(java.lang.String... headerPatterns) Removes all headers provided via array of 'headerPatterns'.
void	setContentType(MimeType contentType)
void	setErrorChannel(MessageChannel errorChannel)
void	setErrorChannelName(java.lang.String errorChannelName)
void	setHeader(java.lang.String name, java.lang.Object value) Set the value for the given header name.
void	setHeaderIfAbsent(java.lang.String name, java.lang.Object value) Set the value for the given header name only if the header name is not already associated with a value.
void	setReplyChannel(MessageChannel replyChannel)
void	setReplyChannelName(java.lang.String replyChannelName)
java.util.Map<java.lang.String,java.lang.Object>	toMap() Return a header map including original, wrapped headers (if any) plus additional header updates made through accessor methods.
java.lang.String	toString()
protected void	verifyType(java.lang.String headerName, java.lang.Object headerValue)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Log logger

originalHeaders

private final MessageHeaders originalHeaders

headers

private final java.util.Map<java.lang.String,java.lang.Object> headers

Constructor Detail

MessageHeaderAccessor

public MessageHeaderAccessor()

A constructor for creating new message headers.

MessageHeaderAccessor

public MessageHeaderAccessor(Message<?> message)

A constructor for accessing and modifying existing message headers.

Method Detail

toMap

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

Return a header map including original, wrapped headers (if any) plus additional header updates made through accessor methods.

isModified

public boolean isModified()

getHeader

public java.lang.Object getHeader(java.lang.String headerName)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.Object value)

Set the value for the given header name. If the provided value is null the header will be removed.

isReadOnly

protected boolean isReadOnly(java.lang.String headerName)

setHeaderIfAbsent

public void setHeaderIfAbsent(java.lang.String name,
                              java.lang.Object value)

Set the value for the given header name only if the header name is not already associated with a value.

removeHeaders

public void removeHeaders(java.lang.String... headerPatterns)

Removes all headers provided via array of 'headerPatterns'. As the name suggests the array may contain simple matching patterns for header names. Supported pattern styles are: "xxx*", "*xxx", "*xxx*" and "xxx*yyy".

getMatchingHeaderNames

private java.util.List<java.lang.String> getMatchingHeaderNames(java.lang.String pattern,
                                                                java.util.Map<java.lang.String,java.lang.Object> headers)

removeHeader

public void removeHeader(java.lang.String headerName)

Remove the value for the given header name.

copyHeaders

public void copyHeaders(java.util.Map<java.lang.String,?> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will overwrite any existing values. Use { copyHeadersIfAbsent(Map) to avoid overwriting values.

copyHeadersIfAbsent

public void copyHeadersIfAbsent(java.util.Map<java.lang.String,?> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will not overwrite any existing values.

getId

public java.util.UUID getId()

getTimestamp

public java.lang.Long getTimestamp()

setReplyChannel

public void setReplyChannel(MessageChannel replyChannel)

getReplyChannel

public java.lang.Object getReplyChannel()

setReplyChannelName

public void setReplyChannelName(java.lang.String replyChannelName)

setErrorChannel

public void setErrorChannel(MessageChannel errorChannel)

getErrorChannel

public java.lang.Object getErrorChannel()

setErrorChannelName

public void setErrorChannelName(java.lang.String errorChannelName)

getContentType

public MimeType getContentType()

setContentType

public void setContentType(MimeType contentType)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

verifyType

protected void verifyType(java.lang.String headerName,
                          java.lang.Object headerValue)