org.mule.routing.inbound
Class WireTap

java.lang.Object
  extended by org.mule.routing.AbstractRouter
      extended by org.mule.routing.inbound.SelectiveConsumer
          extended by org.mule.routing.inbound.WireTap
All Implemented Interfaces:
UMOInboundRouter, UMORouter

public class WireTap
extends SelectiveConsumer

An inbound router that can forward every message to another destination as defined in the "endpoint" property. This can be a logical destination of a URI.

A filter can be applied to this router so that only events matching a criteria will be tapped.


Field Summary
 
Fields inherited from class org.mule.routing.inbound.SelectiveConsumer
logger
 
Constructor Summary
WireTap()
           
 
Method Summary
 String getEndpoint()
           
 boolean isMatch(UMOEvent event)
          Determines if the event should be processed by this router.
 UMOEvent[] process(UMOEvent event)
          A received UMOEvent is passed to this method for processing.
 void setEndpoint(String endpoint)
           
 
Methods inherited from class org.mule.routing.inbound.SelectiveConsumer
getFilter, isTransformFirst, setFilter, setTransformFirst
 
Methods inherited from class org.mule.routing.AbstractRouter
getRouterStatistics, 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.umo.routing.UMORouter
getRouterStatistics, setRouterStatistics
 

Constructor Detail

WireTap

public WireTap()
Method Detail

isMatch

public boolean isMatch(UMOEvent event)
                throws MessagingException
Description copied from interface: UMOInboundRouter
Determines if the event should be processed by this router. Routers can be selectively invoked by configuing a filter on them. Usually the filter is applied to the event when calling this method. All core Mule inbound routers extend the SelectiveConsumer router.

Specified by:
isMatch in interface UMOInboundRouter
Overrides:
isMatch in class SelectiveConsumer
Parameters:
event - the current event to evaluate
Returns:
true if the event should be processed by this router
Throws:
MessagingException - if the event cannot be evaluated
See Also:
SelectiveConsumer

process

public UMOEvent[] process(UMOEvent event)
                   throws MessagingException
Description copied from interface: UMOInboundRouter
A received UMOEvent is passed to this method for processing. The router can control processing by either 1. passing back a null to indicate that the router has either discarded the event of the event has been stored for further processing. A reaosn for storing the event might be that other events in it's correlation group are expected to be received. 2. Pass back an array of one or more events to be processed by the component. Often 1 event is returned, i.e. in the case of event aggregation. The router may return an array of events if a set of events have been resequenced or multiple events have been generated from a single event.

Specified by:
process in interface UMOInboundRouter
Overrides:
process in class SelectiveConsumer
Parameters:
event - the event received by the inbound endpoint before it is passed to the component
Returns:
null to indicate the event has been stored/destroyed or an array of events to be processed by the component
Throws:
MessagingException - if an error occurs during processing of the event

getEndpoint

public String getEndpoint()

setEndpoint

public void setEndpoint(String endpoint)
                 throws UMOException
Throws:
UMOException


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.