Class AbstractMessageSplitter

  extended by org.springframework.integration.context.IntegrationObjectSupport
      extended by org.springframework.integration.handler.AbstractMessageHandler
          extended by org.springframework.integration.handler.AbstractReplyProducingMessageHandler
              extended by org.springframework.integration.splitter.AbstractMessageSplitter
All Implemented Interfaces:
BeanFactoryAware, BeanNameAware, InitializingBean, Ordered, NamedComponent, Orderable, MessageHandler, MessageProducer, TrackableComponent
Direct Known Subclasses:
DefaultMessageSplitter, ExpressionEvaluatingSplitter, MethodInvokingSplitter, XPathMessageSplitter

public abstract class AbstractMessageSplitter
extends AbstractReplyProducingMessageHandler

Base class for Message-splitting handlers.

Field Summary
Fields inherited from class org.springframework.integration.handler.AbstractMessageHandler
Fields inherited from interface org.springframework.core.Ordered
Constructor Summary
Method Summary
 java.lang.String getComponentType()
          Subclasses may implement this method to provide component type information.
protected  java.lang.Object handleRequestMessage(Message<?> message)
          Subclasses must implement this method to handle the request Message.
 void setApplySequence(boolean applySequence)
          Set the applySequence flag to the specified value.
protected abstract  java.lang.Object splitMessage(Message<?> message)
          Subclasses must override this method to split the received Message.
Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
getMessagingTemplate, handleMessageInternal, onInit, setChannelResolver, setOutputChannel, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
getOrder, handleMessage, setOrder, setShouldTrack
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, getBeanFactory, getComponentName, getConversionService, getTaskScheduler, setBeanFactory, setBeanName, setComponentName, setConversionService, 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.integration.context.NamedComponent

Constructor Detail


public AbstractMessageSplitter()
Method Detail


public void setApplySequence(boolean applySequence)
Set the applySequence flag to the specified value. Defaults to true.


protected final java.lang.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


public java.lang.String getComponentType()
Description copied from class: IntegrationObjectSupport
Subclasses may implement this method to provide component type information.

Specified by:
getComponentType in interface NamedComponent
getComponentType in class AbstractMessageHandler


protected abstract java.lang.Object splitMessage(Message<?> message)
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.