org.springframework.integration.mapping

Class AbstractHeaderMapper<T>

java.lang.Object

org.springframework.integration.mapping.AbstractHeaderMapper<T>

All Implemented Interfaces:

RequestReplyHeaderMapper<T>

Direct Known Subclasses:

DefaultAmqpHeaderMapper, DefaultSoapHeaderMapper, DefaultXmppHeaderMapper

public abstract class AbstractHeaderMapper<T>
extends Object
implements RequestReplyHeaderMapper<T>

Abstract base class for HeaderMapper implementations.

Since:

2.1

Author:

Mark Fisher, Oleg Zhurakousky

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger
static String	STANDARD_REPLY_HEADER_NAME_PATTERN
static String	STANDARD_REQUEST_HEADER_NAME_PATTERN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHeaderMapper()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Map<String,Object>	extractStandardHeaders(T source)
protected abstract Map<String,Object>	extractUserDefinedHeaders(T source)
void	fromHeadersToReply(MessageHeaders headers, T target) Maps headers from a Spring Integration MessageHeaders instance to the target instance matching on the set of REPLY headers (if different).
void	fromHeadersToRequest(MessageHeaders headers, T target) Maps headers from a Spring Integration MessageHeaders instance to the target instance matching on the set of REQUEST headers (if different).
protected <V> V	getHeaderIfAvailable(Map<String,Object> headers, String name, Class<V> type)
protected abstract String	getStandardHeaderPrefix()
protected List<String>	getStandardReplyHeaderNames()
protected List<String>	getStandardRequestHeaderNames()
protected abstract void	populateStandardHeaders(Map<String,Object> headers, T target)
protected abstract void	populateUserDefinedHeader(String headerName, Object headerValue, T target)
void	setReplyHeaderNames(String[] replyHeaderNames) Provide the header names that should be mapped to a response (for inbound/outbound adapters) FROM a Spring Integration Message's headers.
void	setRequestHeaderNames(String[] requestHeaderNames) Provide the header names that should be mapped from a request (for inbound/outbound adapters) TO a Spring Integration Message's headers.
void	setUserDefinedHeaderPrefix(String userDefinedHeaderPrefix) Specify a prefix to be prepended to the header name for any integration message header that is being mapped to or from a user-defined value.
Map<String,Object>	toHeadersFromReply(T source) Maps headers/properties of the target object to Map of MessageHeaders matching on the set of REPLY headers
Map<String,Object>	toHeadersFromRequest(T source) Maps headers/properties of the target object to Map of MessageHeaders matching on the set of REQUEST headers

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_REQUEST_HEADER_NAME_PATTERN

public static final String STANDARD_REQUEST_HEADER_NAME_PATTERN

See Also:

Constant Field Values

STANDARD_REPLY_HEADER_NAME_PATTERN

public static final String STANDARD_REPLY_HEADER_NAME_PATTERN

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AbstractHeaderMapper

protected AbstractHeaderMapper()

Method Detail

setRequestHeaderNames

public void setRequestHeaderNames(String[] requestHeaderNames)

Provide the header names that should be mapped from a request (for inbound/outbound adapters) TO a Spring Integration Message's headers. The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.

This will match the header name directly or, for non-standard headers, it will match the header name prefixed with the value, if specified, by setUserDefinedHeaderPrefix(String).

Parameters:

requestHeaderNames - The request header names.

setReplyHeaderNames

public void setReplyHeaderNames(String[] replyHeaderNames)

Provide the header names that should be mapped to a response (for inbound/outbound adapters) FROM a Spring Integration Message's headers. The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.

Any non-standard headers will be prefixed with the value specified by setUserDefinedHeaderPrefix(String).

Parameters:

replyHeaderNames - The reply header names.

setUserDefinedHeaderPrefix

public void setUserDefinedHeaderPrefix(String userDefinedHeaderPrefix)

Specify a prefix to be prepended to the header name for any integration message header that is being mapped to or from a user-defined value.

This does not affect the standard properties for the particular protocol, such as contentType for AMQP, etc. The header names used for mapping such properties are defined in a corresponding Headers class as constants (e.g. AmqpHeaders).

Parameters:

userDefinedHeaderPrefix - The user defined header prefix.

fromHeadersToRequest

public void fromHeadersToRequest(MessageHeaders headers,
                        T target)

Maps headers from a Spring Integration MessageHeaders instance to the target instance matching on the set of REQUEST headers (if different).

Specified by:

fromHeadersToRequest in interface RequestReplyHeaderMapper<T>

Parameters:

headers - The headers.

target - The target.

fromHeadersToReply

public void fromHeadersToReply(MessageHeaders headers,
                      T target)

Maps headers from a Spring Integration MessageHeaders instance to the target instance matching on the set of REPLY headers (if different).

Specified by:

fromHeadersToReply in interface RequestReplyHeaderMapper<T>

Parameters:

headers - The headers.

target - The target.

toHeadersFromRequest

public Map<String,Object> toHeadersFromRequest(T source)

Maps headers/properties of the target object to Map of MessageHeaders matching on the set of REQUEST headers

Specified by:

toHeadersFromRequest in interface RequestReplyHeaderMapper<T>

Parameters:

source - The source.

Returns:

The headers.

toHeadersFromReply

public Map<String,Object> toHeadersFromReply(T source)

Maps headers/properties of the target object to Map of MessageHeaders matching on the set of REPLY headers

Specified by:

toHeadersFromReply in interface RequestReplyHeaderMapper<T>

Parameters:

source - The source.

Returns:

The headers.

getHeaderIfAvailable

protected <V> V getHeaderIfAvailable(Map<String,Object> headers,
                         String name,
                         Class<V> type)

getStandardReplyHeaderNames

protected List<String> getStandardReplyHeaderNames()

Returns:

The list of standard REQUEST headers. Implementation provided by a subclass

getStandardRequestHeaderNames

protected List<String> getStandardRequestHeaderNames()

Returns:

The PREFIX used by standard headers (if any)

getStandardHeaderPrefix

protected abstract String getStandardHeaderPrefix()

Returns:

The list of standard REPLY headers. Implementation provided by a subclass

extractStandardHeaders

protected abstract Map<String,Object> extractStandardHeaders(T source)

extractUserDefinedHeaders

protected abstract Map<String,Object> extractUserDefinedHeaders(T source)

populateStandardHeaders

protected abstract void populateStandardHeaders(Map<String,Object> headers,
                           T target)

populateUserDefinedHeader

protected abstract void populateUserDefinedHeader(String headerName,
                             Object headerValue,
                             T target)