org.mule.runtime.core.processor

Class AbstractRequestResponseMessageProcessor

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.AbstractRequestResponseMessageProcessor

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:

AbstractEnvelopeInterceptor

public abstract class AbstractRequestResponseMessageProcessor
extends AbstractInterceptingMessageProcessor

Base implementation of a Processor that may performs processing during both the request and response processing phases while supporting non-blocking execution.

In order to define the process during the request phase you should override the processRequest(org.mule.runtime.core.api.Event) method. Symmetrically, if you need to define a process to be executed during the response phase, then you should override the processResponse(Event) method.

In some cases you'll have some code that should be always executed, even if an error occurs, for those cases you should override the processFinally(org.mule.runtime.core.api.Event, MessagingException) method.

Since:

3.7.0

Nested Class Summary

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

ReactiveProcessor.ProcessingType

Field Summary

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
AbstractRequestResponseMessageProcessor()

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Event>	apply(org.reactivestreams.Publisher<Event> publisher) Applies a Publisher function transforming a stream of Event's.
Event	process(Event event) Invokes the MessageProcessor.
protected Event	processCatch(Event event, MessagingException exception)
protected void	processFinally(Event event, MessagingException exception) Used to perform post processing after both request and response phases have been completed.
protected ReactiveProcessor	processRequest() Processes the request phase before the next message processor is invoked.
protected Event	processRequest(Event request) Processes the request phase before the next message processor is invoked.
protected ReactiveProcessor	processResponse() Processes the response phase after the next message processor and it's response phase have been invoked
protected Event	processResponse(Event response) Processes the response phase after the next message processor and it's response phase have been invoked

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

Constructor Detail

AbstractRequestResponseMessageProcessor

public AbstractRequestResponseMessageProcessor()

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

processRequest

protected Event processRequest(Event request)
                        throws org.mule.runtime.api.exception.MuleException

Processes the request phase before the next message processor is invoked.

Parameters:

request - event to be processed.

Returns:

result of request processing.

Throws:

org.mule.runtime.api.exception.MuleException - exception thrown by implementations of this method whiile performing response processing

processRequest

protected ReactiveProcessor processRequest()

Processes the request phase before the next message processor is invoked.

Returns:

function that performs request processing

processResponse

protected Event processResponse(Event response)
                         throws org.mule.runtime.api.exception.MuleException

Processes the response phase after the next message processor and it's response phase have been invoked

Parameters:

response - response event to be processed.

Returns:

result of response processing.

Throws:

org.mule.runtime.api.exception.MuleException - exception thrown by implementations of this method whiile performing response processing

processResponse

protected ReactiveProcessor processResponse()

Processes the response phase after the next message processor and it's response phase have been invoked

Returns:

function that performs request processing

processFinally

protected void processFinally(Event event,
                              MessagingException exception)

Used to perform post processing after both request and response phases have been completed. This method will be invoked both when processing is successful as well as if an exception is thrown. successful result and in the case of an exception being thrown.

Parameters:

event - the result of request and response processing. Note that this includes the request and response processing of the rest of the Flow following this message processor too.

exception - the exception thrown during processing if any. If not exception was thrown then this parameter is null

processCatch

protected Event processCatch(Event event,
                             MessagingException exception)
                      throws MessagingException

Throws:

MessagingException