Package org.springframework.integration.transformer

Class MessageTransformingHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.transformer.MessageTransformingHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class MessageTransformingHandler
extends AbstractReplyProducingMessageHandler
implements ManageableLifecycle

A reply-producing MessageHandler that delegates to a Transformer instance to modify the received Message and sends the result to its output channel.

Author:

Mark Fisher, Oleg Zhurakousky, Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MessageTransformingHandler(Transformer transformer)	Create a MessageTransformingHandler instance that delegates to the provided Transformer.

Method Summary

Modifier and Type	Method	Description
void	addNotPropagatedHeaders(String... headers)	Add header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message if AbstractMessageProducingHandler.shouldCopyRequestHeaders() is true, instead of overwriting the existing set.
protected void	doInit()
String	getComponentType()	Subclasses may implement this method to provide component type information.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
protected Object	handleRequestMessage(Message<?> message)	Subclasses must implement this method to handle the request Message.
boolean	isRunning()
protected boolean	shouldCopyRequestHeaders()	Subclasses may override this.
void	start()
void	stop()

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Details

MessageTransformingHandler

public MessageTransformingHandler(Transformer transformer)

Create a MessageTransformingHandler instance that delegates to the provided Transformer.

Parameters:

transformer - The transformer.

Method Details

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 MessageHandlerSupport

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Overrides:

getIntegrationPatternType in class AbstractReplyProducingMessageHandler

Returns:

the IntegrationPatternType this component implements.

addNotPropagatedHeaders

public void addNotPropagatedHeaders(String... headers)

Description copied from class: AbstractMessageProducingHandler

Add header patterns ("xxx*", "*xxx", "*xxx*" or "xxx*yyy") that will NOT be copied from the inbound message if AbstractMessageProducingHandler.shouldCopyRequestHeaders() is true, instead of overwriting the existing set.

Specified by:

addNotPropagatedHeaders in interface HeaderPropagationAware

Overrides:

addNotPropagatedHeaders in class AbstractMessageProducingHandler

Parameters:

headers - the headers to not propagate from the inbound message.

See Also:

• AbstractMessageProducingHandler.setNotPropagatedHeaders(String...)

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

start

public void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

Specified by:

isRunning in interface ManageableLifecycle

handleRequestMessage

protected Object handleRequestMessage(Message<?> message)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

message - The request message.

Returns:

The result of handling the message, or null.

shouldCopyRequestHeaders

protected boolean shouldCopyRequestHeaders()

Description copied from class: AbstractMessageProducingHandler

Subclasses may override this. True by default.

Overrides:

shouldCopyRequestHeaders in class AbstractMessageProducingHandler

Returns:

true if the request headers should be copied.