org.ikasan.framework.component.routing
Interface Router

All Superinterfaces:

FlowComponent

All Known Implementing Classes:

AbstractFilteringRouter, ContainsPayloadRouter, FirstPayloadAttributeRouter, RecipientListRouter, SingleResultRouter, XMLValidatorRouter, XPathBooleanRouter, XPathSelectorRouter

public interface Router
extends FlowComponent

Interface for all FlowComponents that perform a Routing function. These are characterised by a dynamic evaluation of business path. The resultant path or paths for the given Event are identified by the values in the resultant List

Author:

Ikasan Development Team

Field Summary

static String

DEFAULT_RESULT Default result for any unresolved routing implementation

Method Summary

List<String>

onEvent(Event event) Handles the Event in a read-only fashion, returning an ordered List of paths/routes for this Event to take next

Field Detail

DEFAULT_RESULT

static final String DEFAULT_RESULT

Default result for any unresolved routing implementation

See Also:

Constant Field Values

Method Detail

onEvent

List<String> onEvent(Event event)
                     throws RouterException

Handles the Event in a read-only fashion, returning an ordered List of paths/routes for this Event to take next

Parameters:

event - Event to handle

Returns:

List of paths/routes for this Event to take next

Throws:

RouterException - - if the result cannot be calculated for any reason