org.mule.runtime.core.routing

Class MessageFilter

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

org.mule.runtime.core.processor.AbstractInterceptingMessageProcessor

org.mule.runtime.core.processor.AbstractFilteringMessageProcessor

org.mule.runtime.core.routing.MessageFilter

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, InterceptingMessageProcessor, Processor, ReactiveProcessor

public class MessageFilter
extends AbstractFilteringMessageProcessor
implements FlowConstructAware, org.mule.runtime.api.lifecycle.Lifecycle

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
protected Filter	filter

Fields inherited from class org.mule.runtime.core.processor.AbstractFilteringMessageProcessor

onUnacceptedFlowConstruct, throwOnUnaccepted, unacceptedMessageProcessor

Fields inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

flowConstruct, logger, muleContext, next

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

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

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

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

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
MessageFilter() Deprecated. Use MessageFilter(Filter filter)
MessageFilter(Filter filter)
MessageFilter(Filter filter, boolean throwExceptionOnUnaccepted, Processor messageProcessor)

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(Event event, Event.Builder builder)
void	dispose()
protected MessagingException	filterFailureException(Event event, Exception ex)
protected org.mule.runtime.api.exception.MuleException	filterUnacceptedException(Event event)
Filter	getFilter()
void	initialise()
void	setFilter(Filter filter)
void	setFlowConstruct(FlowConstruct flowConstruct)
void	setMuleContext(MuleContext context)
void	start()
void	stop()
String	toString()

Methods inherited from class org.mule.runtime.core.processor.AbstractFilteringMessageProcessor

apply, getUnacceptedMessageProcessor, handleUnaccepted, isThrowOnUnaccepted, process, setThrowOnUnaccepted, setUnacceptedMessageProcessor

Methods inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

applyNext, getListener, getMuleContext, isEventValid, processNext, setListener

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.api.processor.InterceptingMessageProcessor

setListener

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

getProcessingType

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

filter

protected Filter filter

Constructor Detail

MessageFilter

@Deprecated
public MessageFilter()

Deprecated. Use MessageFilter(Filter filter)

For IoC only

MessageFilter

public MessageFilter(Filter filter)

MessageFilter

public MessageFilter(Filter filter,
                     boolean throwExceptionOnUnaccepted,
                     Processor messageProcessor)

Parameters:

filter -

throwExceptionOnUnaccepted - throw a FilterUnacceptedException when a message is rejected by the filter?

messageProcessor - used to handler unaccepted messages

Method Detail

accept

protected boolean accept(Event event,
                         Event.Builder builder)

Specified by:

accept in class AbstractFilteringMessageProcessor

filterFailureException

protected MessagingException filterFailureException(Event event,
                                                    Exception ex)

Overrides:

filterFailureException in class AbstractFilteringMessageProcessor

filterUnacceptedException

protected org.mule.runtime.api.exception.MuleException filterUnacceptedException(Event event)

Overrides:

filterUnacceptedException in class AbstractFilteringMessageProcessor

getFilter

public Filter getFilter()

setFilter

public void setFilter(Filter filter)

toString

public String toString()

Overrides:

toString in class AbstractInterceptingMessageProcessorBase

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Overrides:

setMuleContext in class AbstractInterceptingMessageProcessorBase

Parameters:

context - the Mule node.

setFlowConstruct

public void setFlowConstruct(FlowConstruct flowConstruct)

Specified by:

setFlowConstruct in interface FlowConstructAware

Overrides:

setFlowConstruct in class AbstractInterceptingMessageProcessorBase

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable