Package org.springframework.messaging.support

Class AbstractHeaderMapper<T>

java.lang.Object

org.springframework.messaging.support.AbstractHeaderMapper<T>

Type Parameters:

T - type of the instance to and from which headers will be mapped

All Implemented Interfaces:

HeaderMapper<T>

Direct Known Subclasses:

SimpleJmsHeaderMapper

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

A base HeaderMapper implementation.

Since:

4.1

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor	Description
AbstractHeaderMapper()

Method Summary

Modifier and Type	Method	Description
protected String	fromHeaderName(String headerName)	Generate the name to use to set the header defined by the specified headerName to the protocol specific message.
protected <V> @Nullable V	getHeaderIfAvailable(Map<String,Object> headers, String name, Class<V> type)	Return the header value, or null if it does not exist or does not match the requested type.
void	setInboundPrefix(@Nullable String inboundPrefix)	Specify a prefix to be appended to the message header name for any user-defined property that is being mapped into the MessageHeaders.
void	setOutboundPrefix(@Nullable String outboundPrefix)	Specify a prefix to be appended to the protocol property name for any user-defined message header that is being mapped into the protocol-specific Message.
protected String	toHeaderName(String propertyName)	Generate the name to use to set the header defined by the specified propertyName to the MessageHeaders instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.support.HeaderMapper

fromHeaders, toHeaders

Field Details

logger

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

Constructor Details

AbstractHeaderMapper

public AbstractHeaderMapper()

Method Details

setInboundPrefix

public void setInboundPrefix(@Nullable String inboundPrefix)

Specify a prefix to be appended to the message header name for any user-defined property that is being mapped into the MessageHeaders. The default is an empty String (no prefix).

setOutboundPrefix

public void setOutboundPrefix(@Nullable String outboundPrefix)

Specify a prefix to be appended to the protocol property name for any user-defined message header that is being mapped into the protocol-specific Message. The default is an empty String (no prefix).

fromHeaderName

protected String fromHeaderName(String headerName)

Generate the name to use to set the header defined by the specified headerName to the protocol specific message.

See Also:

• setOutboundPrefix(java.lang.String)

toHeaderName

protected String toHeaderName(String propertyName)

Generate the name to use to set the header defined by the specified propertyName to the MessageHeaders instance.

See Also:

• setInboundPrefix(String)

getHeaderIfAvailable

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

Return the header value, or null if it does not exist or does not match the requested type.