org.mule.routing.outbound

Class TransformerRouter

java.lang.Object

org.mule.routing.AbstractRouter

org.mule.routing.outbound.AbstractOutboundRouter

org.mule.routing.outbound.TransformerRouter

All Implemented Interfaces:

MuleContextAware, Disposable, Initialisable, OutboundRouter, Router

public class TransformerRouter
extends AbstractOutboundRouter

Simply applies a transformer before continuing on to the next router. This can be useful with the ChainingRouter.

Field Summary

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

Constructors

Constructor and Description
TransformerRouter()

Method Summary

Methods

Modifier and Type	Method and Description
Transformer	getTransformer()
boolean	isMatch(MuleMessage message) Determines if the event should be processed by this router.
MuleMessage	route(MuleMessage message, MuleSession session, boolean synchronous) This method is responsible for routing the Message via the MuleSession.
void	setTransformer(Transformer transformer)

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

addEndpoint, 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

Constructor Detail

TransformerRouter

public TransformerRouter()

Method Detail

route

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

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.

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:

MessagingException - if any errors occur during the sending of messages

See Also:

FilteringOutboundRouter, ExceptionBasedRouter, MulticastingRouter

isMatch

public boolean isMatch(MuleMessage message)
                throws MessagingException

Description copied from interface: OutboundRouter

Determines if the event should be processed by this router. Routers can be selectively invoked by configuring a filter on them. Usually the filter is applied to the message when calling this method. All core Mule outbound routers extend the FilteringOutboundRouter router that handles this method automatically.

Parameters:

message - the current message to evaluate

Returns:

true if the event should be processed by this router

Throws:

MessagingException - if the event cannot be evaluated

See Also:

SelectiveConsumer

getTransformer

public Transformer getTransformer()

setTransformer

public void setTransformer(Transformer transformer)