Class HeaderFilter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.HeaderFilter

All Implemented Interfaces:

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

public class HeaderFilter
extends IntegrationObjectSupport
implements Transformer, IntegrationPattern

Transformer that removes Message headers.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
HeaderFilter()	Create an instance of the class.
HeaderFilter(String... headersToRemove)

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.
protected void	onInit()	Subclasses may implement this for initialization logic.
final void	setHeadersToRemove(String... headersToRemove)	Set a list of header names (or patterns) to remove from a request message.
void	setPatternMatch(boolean patternMatch)
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

HeaderFilter

public HeaderFilter()

Create an instance of the class. The setHeadersToRemove(java.lang.String...) must be called afterwards.

Since:

6.2

HeaderFilter

public HeaderFilter(String... headersToRemove)

Method Details

setHeadersToRemove

public final void setHeadersToRemove(String... headersToRemove)

Set a list of header names (or patterns) to remove from a request message.

Parameters:

headersToRemove - the list of header names (or patterns) to remove from a request message.

Since:

6.2

setPatternMatch

public void setPatternMatch(boolean patternMatch)

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

protected 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