org.mule.processor

Class AbstractRequestResponseMessageProcessor

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.processor.AbstractInterceptingMessageProcessorBase

org.mule.processor.AbstractInterceptingMessageProcessor

org.mule.processor.AbstractRequestResponseMessageProcessor

All Implemented Interfaces:

AnnotatedObject, MuleContextAware, NonBlockingSupported, InterceptingMessageProcessor, MessageProcessor, MessageProcessorContainer, MessageSource

Direct Known Subclasses:

AbstractEnvelopeInterceptor, OutboundResponsePropertiesMessageProcessor, ResponseMessageProcessorAdapter

public abstract class AbstractRequestResponseMessageProcessor
extends AbstractInterceptingMessageProcessor
implements NonBlockingSupported

Base implementation of a MessageProcessor 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.api.MuleEvent) method. Symmetrically, if you need to define a process to be executed during the response phase, then you should override the processResponse(MuleEvent, MuleEvent) 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.api.MuleEvent, org.mule.api.MessagingException) method.

Since:

3.7.0

Field Summary

Fields inherited from class org.mule.processor.AbstractInterceptingMessageProcessorBase

logger, muleContext, next, notificationHandler

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRequestResponseMessageProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected ReplyToHandler	createReplyToHandler(MuleEvent request)
MuleEvent	process(MuleEvent event) Invokes the MessageProcessor.
protected MuleEvent	processBlocking(MuleEvent event)
protected void	processFinally(MuleEvent event, MessagingException exception) Used to perform post processing after both request and response phases have been completed.
protected MuleEvent	processNonBlocking(MuleEvent event)
protected MuleEvent	processRequest(MuleEvent request) Processes the request phase before the next message processor is invoked.
protected MuleEvent	processResponse(MuleEvent response) Deprecated.
protected MuleEvent	processResponse(MuleEvent response, MuleEvent request) Processes the response phase after the next message processor and it's response phase have been invoked

Methods inherited from class org.mule.processor.AbstractInterceptingMessageProcessorBase

addMessageProcessorPathElements, getListener, getMuleContext, isEventValid, processNext, setListener, setMuleContext, toString

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.source.MessageSource

setListener

Constructor Detail

AbstractRequestResponseMessageProcessor

public AbstractRequestResponseMessageProcessor()

Method Detail

process

public final MuleEvent process(MuleEvent event)
                        throws MuleException

Description copied from interface: MessageProcessor

Invokes the MessageProcessor.

Specified by:

process in interface MessageProcessor

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

MuleException

processBlocking

protected MuleEvent processBlocking(MuleEvent event)
                             throws MuleException

Throws:

MuleException

processNonBlocking

protected MuleEvent processNonBlocking(MuleEvent event)
                                throws MuleException

Throws:

MuleException

createReplyToHandler

protected ReplyToHandler createReplyToHandler(MuleEvent request)

processRequest

protected MuleEvent processRequest(MuleEvent request)
                            throws MuleException

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

Parameters:

request - event to be processed.

Returns:

result of request processing.

Throws:

MuleException - exception thrown by implementations of this method whiile performing response processing

processResponse

protected MuleEvent processResponse(MuleEvent response,
                        MuleEvent request)
                             throws 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.

request - the request event

Returns:

result of response processing.

Throws:

MuleException - exception thrown by implementations of this method whiile performing response processing

processResponse

@Deprecated
protected MuleEvent processResponse(MuleEvent response)
                             throws MuleException

Deprecated.

Processes the response phase after the next message processor and it's response phase have been invoked. This method is deprecated, use processResponse(MuleEvent, MuleEvent) instead.

Parameters:

response - response event to be processed.

Returns:

result of response processing.

Throws:

MuleException - exception thrown by implementations of this method whiile performing response processing

processFinally

protected void processFinally(MuleEvent 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