org.mule.routing
Class MessageFilter

java.lang.Object
  org.mule.processor.AbstractInterceptingMessageProcessor
      org.mule.processor.AbstractFilteringMessageProcessor
          org.mule.routing.MessageFilter

All Implemented Interfaces:

InterceptingMessageProcessor, MessageProcessor, MessageSource

Direct Known Subclasses:

ExceptionThrowingMessageFilter, ForwardingConsumer, IdempotentMessageFilter

public class MessageFilter
extends AbstractFilteringMessageProcessor

Implementation of InterceptingMessageProcessor that filters message flow using a Filter. Is the filter accepts the message then message flow continues to the next message processor. If the filter does not accept the message processor and a message processor is configured for handling unaccepted message then this will be invoked, otherwise null will be returned.

EIP Reference: http://www.eaipatterns.com/Filter.html

Field Summary

protected Filter	filter
protected boolean	throwOnUnaccepted
protected MessageProcessor	unacceptedMessageProcessor

Fields inherited from class org.mule.processor.AbstractInterceptingMessageProcessor

logger, next

Constructor Summary

MessageFilter()

MessageFilter(Filter filter)

MessageFilter(Filter filter, MessageProcessor messageProcessor)

Method Summary

protected boolean	accept(MuleEvent event)
Filter	getFilter()
MessageProcessor	getUnacceptedMessageProcessor()
protected MuleEvent	handleUnaccepted(MuleEvent event)
void	setFilter(Filter filter)
void	setThrowOnUnaccepted(boolean throwOnUnaccepted)
void	setUnacceptedMessageProcessor(MessageProcessor unacceptedMessageProcessor) The MessageProcessor that should be used to handle messaged that are not accepted by the filter.
String	toString()

Methods inherited from class org.mule.processor.AbstractFilteringMessageProcessor

process

Methods inherited from class org.mule.processor.AbstractInterceptingMessageProcessor

processNext, setListener

Methods inherited from class java.lang.Object

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

Field Detail

filter

protected Filter filter

unacceptedMessageProcessor

protected MessageProcessor unacceptedMessageProcessor

throwOnUnaccepted

protected boolean throwOnUnaccepted

Constructor Detail

MessageFilter

public MessageFilter()

MessageFilter

public MessageFilter(Filter filter)

MessageFilter

public MessageFilter(Filter filter,
                     MessageProcessor messageProcessor)

Parameters:

filter -

messageProcessor - used to handler unaccepted messages

Method Detail

accept

protected boolean accept(MuleEvent event)

Specified by:

accept in class AbstractFilteringMessageProcessor

handleUnaccepted

protected MuleEvent handleUnaccepted(MuleEvent event)
                              throws MuleException

Overrides:

handleUnaccepted in class AbstractFilteringMessageProcessor

Throws:

MuleException

setUnacceptedMessageProcessor

public void setUnacceptedMessageProcessor(MessageProcessor unacceptedMessageProcessor)

The MessageProcessor that should be used to handle messaged that are not accepted by the filter.

Parameters:

unacceptedMessageProcessor -

getUnacceptedMessageProcessor

public MessageProcessor getUnacceptedMessageProcessor()

getFilter

public Filter getFilter()

setFilter

public void setFilter(Filter filter)

setThrowOnUnaccepted

public void setThrowOnUnaccepted(boolean throwOnUnaccepted)

toString

public String toString()

Overrides:

toString in class AbstractInterceptingMessageProcessor