Package 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, ComponentSourceAware, ExpressionCapable, GenericTransformer<Message<?>,Message<?>>, IntegrationPattern, NamedComponent, Transformer

Direct Known Subclasses:

XPathHeaderEnricher

public class HeaderEnricher
extends IntegrationObjectSupport
implements Transformer, IntegrationPattern

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, Gary Russell, Trung Pham

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getComponentType()	Subclasses may implement this method to provide component type information.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
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, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Details

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 Details

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

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

onInit

public void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

transform

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

Specified by:

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

Specified by:

transform in interface Transformer