org.mule.tck

Class AbstractRequestResponseMessageProcessor

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.core.privileged.processor.AbstractInterceptingMessageProcessorBase

org.mule.runtime.core.privileged.processor.AbstractInterceptingMessageProcessor

org.mule.tck.AbstractRequestResponseMessageProcessor

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<CoreEvent>,org.reactivestreams.Publisher<CoreEvent>>, org.mule.runtime.api.component.Component, MuleContextAware, InterceptingMessageProcessor, Processor, ReactiveProcessor

Direct Known Subclasses:

SensingNullRequestResponseMessageProcessor

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(CoreEvent) method. Symmetrically, if you need to define a process to be executed during the response phase, then you should override the processResponse(CoreEvent) 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(CoreEvent, 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.privileged.processor.AbstractInterceptingMessageProcessorBase

logger, muleContext, next

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRequestResponseMessageProcessor()

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<CoreEvent>	apply(org.reactivestreams.Publisher<CoreEvent> publisher)
CoreEvent	process(CoreEvent event)
protected CoreEvent	processCatch(CoreEvent event, MessagingException exception)
protected void	processFinally(CoreEvent 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 CoreEvent	processRequest(CoreEvent 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 CoreEvent	processResponse(CoreEvent 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.privileged.processor.AbstractInterceptingMessageProcessorBase

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

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getLocation, getRootContainerName, 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 CoreEvent process(CoreEvent event)
                  throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

apply

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

processRequest

protected CoreEvent processRequest(CoreEvent 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 CoreEvent processResponse(CoreEvent 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(CoreEvent 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 CoreEvent processCatch(CoreEvent event,
                                 MessagingException exception)
                          throws MessagingException

Throws:

MessagingException