org.springframework.integration.transformer

Class HeaderEnricher

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.HeaderEnricher

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, NamedComponent, GenericTransformer<Message<?>,Message<?>>, Transformer

Direct Known Subclasses:

XPathHeaderEnricher

public class HeaderEnricher
extends IntegrationObjectSupport
implements Transformer, BeanNameAware, InitializingBean

A Transformer that adds statically configured header values to a Message. Accepts the boolean 'overwrite' property that specifies whether values should be overwritten. By default, any existing header values for a given key, will not be replaced.

Author:

Mark Fisher, David Turanski, Artem Bilan

Constructor Summary

Constructors

Constructor and Description
HeaderEnricher()
HeaderEnricher(Map<String,? extends HeaderValueMessageProcessor<?>> headersToAdd) Create a HeaderEnricher with the given map of headers.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentType() Subclasses may implement this method to provide component type information.
void	onInit() Subclasses may implement this for initialization logic.
void	setDefaultOverwrite(boolean defaultOverwrite)
<T> void	setMessageProcessor(MessageProcessor<T> messageProcessor)
void	setShouldSkipNulls(boolean shouldSkipNulls) Specify whether null values, such as might be returned from an expression evaluation, should be skipped.
Message<?>	transform(Message<?> message)

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.BeanNameAware

setBeanName

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Constructor Detail

HeaderEnricher

public HeaderEnricher()

HeaderEnricher

public HeaderEnricher(Map<String,? extends HeaderValueMessageProcessor<?>> headersToAdd)

Create a HeaderEnricher with the given map of headers.

Parameters:

headersToAdd - The headers to add.

Method Detail

setMessageProcessor

public <T> void setMessageProcessor(MessageProcessor<T> messageProcessor)

setDefaultOverwrite

public void setDefaultOverwrite(boolean defaultOverwrite)

setShouldSkipNulls

public void setShouldSkipNulls(boolean shouldSkipNulls)

Specify whether null values, such as might be returned from an expression evaluation, should be skipped. The default value is true. Set this to false if a null value should trigger removal of the corresponding header instead.

Parameters:

shouldSkipNulls - true when null values should be skipped.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

transform

public Message<?> transform(Message<?> message)

Specified by:

transform in interface GenericTransformer<Message<?>,Message<?>>

Specified by:

transform in interface Transformer

onInit

public void onInit()
            throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

Exception - Any exception.