org.mule.api.routing
Interface OutboundRouterCollection

All Superinterfaces:

Disposable, Initialisable, RouterCollection

All Known Implementing Classes:

DefaultOutboundRouterCollection

public interface OutboundRouterCollection
extends RouterCollection

OutboundRouterCollection is responsible for holding all outbound routers for a service service.

Field Summary

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

PHASE_NAME

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

PHASE_NAME

Method Summary

ImmutableEndpoint[]	getEndpointsForMessage(MuleMessage message) A helper method for finding out which endpoints a message would be routed to without actually routing the the message.
boolean	hasEndpoints() Determines if any endpoints have been set on this router.
MuleMessage	route(MuleMessage message, MuleSession session, boolean synchronous) Prepares one or more events to be dispached by a Message Dispatcher.

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

addRouter, getCatchAllStrategy, getRouters, getStatistics, isMatchAll, removeRouter, setCatchAllStrategy, setMatchAll, setRouters, setStatistics

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

initialise

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

dispose

Method Detail

route

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

Prepares one or more events to be dispached by a Message Dispatcher.

Parameters:

message - The source Message

session - The current session

Returns:

a list containing 0 or events to be dispatched

Throws:

RoutingException - If any of the events cannot be created.

MessagingException

getEndpointsForMessage

ImmutableEndpoint[] getEndpointsForMessage(MuleMessage message)
                                           throws MessagingException

A helper method for finding out which endpoints a message would be routed to without actually routing the the message.

Parameters:

message - the message to retrieve endpoints for

Returns:

an array of Endpoint objects or an empty array

Throws:

RoutingException - if there is a filter exception

MessagingException

hasEndpoints

boolean hasEndpoints()

Determines if any endpoints have been set on this router.

Returns: