org.mule.runtime.core.processor

Class AbstractFilteringMessageProcessor

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

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, InterceptingMessageProcessor, Processor, ReactiveProcessor

Direct Known Subclasses:

MessageFilter, ProcessIfStartedMessageProcessor

public abstract class AbstractFilteringMessageProcessor
extends AbstractInterceptingMessageProcessor

Abstract InterceptingMessageProcessor that can be easily be extended and used for filtering message flow through a Processor chain. The default behaviour when the filter is not accepted is to return the request event.

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 boolean	onUnacceptedFlowConstruct
protected boolean	throwOnUnaccepted Throw a FilterUnacceptedException when a message is rejected by the filter?
protected Processor	unacceptedMessageProcessor The MessageProcessor that should be used to handle messages that are not accepted by the filter.

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.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractFilteringMessageProcessor()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	accept(Event event, Event.Builder builder)
org.reactivestreams.Publisher<Event>	apply(org.reactivestreams.Publisher<Event> publisher) Applies a Publisher function transforming a stream of Event's.
protected MessagingException	filterFailureException(Event event, Exception ex)
protected org.mule.runtime.api.exception.MuleException	filterUnacceptedException(Event event)
Processor	getUnacceptedMessageProcessor()
protected Event	handleUnaccepted(Event event)
boolean	isThrowOnUnaccepted()
Event	process(Event event) Invokes the MessageProcessor.
void	setThrowOnUnaccepted(boolean throwOnUnaccepted)
void	setUnacceptedMessageProcessor(Processor unacceptedMessageProcessor)

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

applyNext, getListener, getMuleContext, isEventValid, processNext, setFlowConstruct, setListener, setMuleContext, toString

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

throwOnUnaccepted

protected boolean throwOnUnaccepted

Throw a FilterUnacceptedException when a message is rejected by the filter?

onUnacceptedFlowConstruct

protected boolean onUnacceptedFlowConstruct

unacceptedMessageProcessor

protected Processor unacceptedMessageProcessor

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

Constructor Detail

AbstractFilteringMessageProcessor

public AbstractFilteringMessageProcessor()

Method Detail

process

public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Processor

Invokes the MessageProcessor.

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

org.mule.runtime.api.exception.MuleException

apply

public org.reactivestreams.Publisher<Event> apply(org.reactivestreams.Publisher<Event> publisher)

Description copied from interface: Processor

Applies a Publisher function transforming a stream of Event's.

The default implementation delegates to Processor.process(Event) and will:

1. propagate any exception thrown
2. drop events if invocation of Processor.process(Event) returns null.

Parameters:

publisher - the event stream to transform

Returns:

the transformed event stream

accept

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

handleUnaccepted

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

Throws:

org.mule.runtime.api.exception.MuleException

filterFailureException

protected MessagingException filterFailureException(Event event,
                                                    Exception ex)

filterUnacceptedException

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

getUnacceptedMessageProcessor

public Processor getUnacceptedMessageProcessor()

setUnacceptedMessageProcessor

public void setUnacceptedMessageProcessor(Processor unacceptedMessageProcessor)

isThrowOnUnaccepted

public boolean isThrowOnUnaccepted()

setThrowOnUnaccepted

public void setThrowOnUnaccepted(boolean throwOnUnaccepted)