org.mule.routing.outbound
Class AbstractMessageSplitter

java.lang.Object
  org.mule.routing.AbstractRouter
      org.mule.routing.outbound.AbstractOutboundRouter
          org.mule.routing.outbound.FilteringOutboundRouter
              org.mule.routing.outbound.AbstractMessageSplitter

All Implemented Interfaces:

MuleContextAware, Disposable, Initialisable, OutboundRouter, Router

Direct Known Subclasses:

FilteringListMessageSplitter

public abstract class AbstractMessageSplitter
extends FilteringOutboundRouter

AbstractMessageSplitter is an outbound Message Splitter used to split the contents of a received message into sub parts that can be processed by other components. Each Part is fired as a separate event to each endpoint on the router. The endpoints can have filters on them to receive only certain message parts.

Field Summary

protected boolean	honorSynchronicity
protected boolean	multimatch

Fields inherited from class org.mule.routing.outbound.AbstractOutboundRouter

ENABLE_CORRELATION_ALWAYS, ENABLE_CORRELATION_IF_NOT_SET, ENABLE_CORRELATION_NEVER, enableCorrelation, endpoints, logger, messageInfoMapping, replyTo, transactionConfig

Fields inherited from class org.mule.routing.AbstractRouter

muleContext

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

AbstractMessageSplitter()

Method Summary

protected abstract void	cleanup() This method is called after all parts of the original message have been processed; typically this is the case after getMessagePart(MuleMessage, OutboundEndpoint) returned null.
protected abstract MuleMessage	getMessagePart(MuleMessage message, OutboundEndpoint endpoint) Retrieves a specific message part for the given endpoint.
protected abstract void	initialise(MuleMessage message) This method can be implemented to split the message up before getMessagePart(MuleMessage, OutboundEndpoint) method is called.
boolean	isHonorSynchronicity()
MuleMessage	route(MuleMessage message, MuleSession session, boolean synchronous) This method is responsible for routing the Message via the MuleSession.
void	setHonorSynchronicity(boolean honorSynchronicity) Sets the flag indicating whether the splitter honurs endpoint settings

Methods inherited from class org.mule.routing.outbound.FilteringOutboundRouter

addEndpoint, getEndpoint, getFilter, getTransformers, isMatch, isUseTemplates, setFilter, setTransformers, setUseTemplates

Methods inherited from class org.mule.routing.outbound.AbstractOutboundRouter

createTransactionTemplate, dispatch, getEnableCorrelation, getEndpoint, getEndpoints, getMessageInfoMapping, getReplyTo, getTransactionConfig, isDynamicEndpoints, removeEndpoint, send, setEnableCorrelation, setEnableCorrelationAsString, setEndpoints, setMessageInfoMapping, setMessageProperties, setReplyTo, setTransactionConfig

Methods inherited from class org.mule.routing.AbstractRouter

dispose, getMuleContext, getRouterStatistics, initialise, setMuleContext, setRouterStatistics

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.routing.Router

getRouterStatistics, setRouterStatistics

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Field Detail

multimatch

protected boolean multimatch

honorSynchronicity

protected boolean honorSynchronicity

Constructor Detail

AbstractMessageSplitter

public AbstractMessageSplitter()

Method Detail

route

public MuleMessage route(MuleMessage message,
                         MuleSession session,
                         boolean synchronous)
                  throws RoutingException

Description copied from interface: OutboundRouter

This method is responsible for routing the Message via the MuleSession. The logic for this method will change for each type of router depending on expected behaviour. For example, a MulticastingRouter might just iterate through the list of assoaciated endpoints sending the message. Another type of router such as the ExceptionBasedRouter will hit the first endpoint, if it fails try the second, and so on. Most router implementations will extends the FilteringOutboundRouter which implements all the common logic need for a router.

Specified by:

route in interface OutboundRouter

Overrides:

route in class FilteringOutboundRouter

Parameters:

message - the message to send via one or more endpoints on this router

session - the session used to actually send the event

synchronous - whether the invocation process should be synchronous or not

Returns:

a result message if any from the invocation. If the synchronous flag is false a null result will always be returned.

Throws:

RoutingException

See Also:

FilteringOutboundRouter, ExceptionBasedRouter, MulticastingRouter

isHonorSynchronicity

public boolean isHonorSynchronicity()

setHonorSynchronicity

public void setHonorSynchronicity(boolean honorSynchronicity)

Sets the flag indicating whether the splitter honurs endpoint settings

Parameters:

honorSynchronicity - flag setting

initialise

protected abstract void initialise(MuleMessage message)

This method can be implemented to split the message up before getMessagePart(MuleMessage, OutboundEndpoint) method is called.

Parameters:

message - the message being routed

getMessagePart

protected abstract MuleMessage getMessagePart(MuleMessage message,
                                              OutboundEndpoint endpoint)

Retrieves a specific message part for the given endpoint. the message will then be routed via the provider.

NOTE:Implementations must provide proper synchronization for shared state (payload, properties, etc.)

Parameters:

message - the current message being processed

endpoint - the endpoint that will be used to route the resulting message part

Returns:

the message part to dispatch

cleanup

protected abstract void cleanup()

This method is called after all parts of the original message have been processed; typically this is the case after getMessagePart(MuleMessage, OutboundEndpoint) returned null.