Class MethodInvokingSplitter

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.splitter.AbstractMessageSplitter

org.springframework.integration.splitter.MethodInvokingSplitter

All Implemented Interfaces:

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

public class MethodInvokingSplitter
extends AbstractMessageSplitter

A Message Splitter implementation that invokes the specified method on the given object. The method's return value will be split if it is a Collection or Array. If the return value is not a Collection or Array, then the single Object will be returned as the payload of a single reply Message.

Author:

Mark Fisher, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MethodInvokingSplitter(Object object)
MethodInvokingSplitter(Object object, Method method)
MethodInvokingSplitter(Object object, String methodName)

Method Summary

Modifier and Type	Method	Description
protected void	doInit()
boolean	isRunning()
protected final @Nullable Object	splitMessage(Message<?> message)	Subclasses must override this method to split the received Message.
void	start()
void	stop()

Methods inherited from class AbstractMessageSplitter

addHeaders, getComponentType, getDiscardChannel, getIntegrationPatternType, handleRequestMessage, obtainSizeIfPossible, obtainSizeIfPossible, produceOutput, setApplySequence, setDiscardChannel, setDiscardChannelName, shouldCopyRequestHeaders, willAddHeaders

Methods inherited from class AbstractReplyProducingMessageHandler

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

Methods inherited from class AbstractMessageProducingHandler

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

Methods inherited from class AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class MessageHandlerSupport

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

Methods inherited from class 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 Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface IntegrationManagement

getThisAs

Methods inherited from interface MessageHandler

handleMessage

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Constructor Details

MethodInvokingSplitter

public MethodInvokingSplitter(Object object,
 Method method)

MethodInvokingSplitter

public MethodInvokingSplitter(Object object,
 String methodName)

MethodInvokingSplitter

public MethodInvokingSplitter(Object object)

Method Details

doInit

protected void doInit()

Overrides:

doInit in class AbstractMessageSplitter

splitMessage

protected final @Nullable Object splitMessage(Message<?> message)

Description copied from class: AbstractMessageSplitter

Subclasses must override this method to split the received Message. The return value may be a Collection or Array. The individual elements may be Messages, but it is not necessary. If the elements are not Messages, each will be provided as the payload of a Message. It is also acceptable to return a single Object or Message. In that case, a single reply Message will be produced.

Specified by:

splitMessage in class AbstractMessageSplitter

Parameters:

message - The message.

Returns:

The result of splitting the message.

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