org.mule.execution

Interface AsyncResponseFlowProcessingPhaseTemplate

All Superinterfaces:

MessageProcessTemplate

All Known Implementing Classes:

HttpMessageProcessorTemplate

public interface AsyncResponseFlowProcessingPhaseTemplate
extends MessageProcessTemplate

Template methods for MessageSource specific behavior during flow execution.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterFailureProcessingFlow(Exception exception) Call when the processing of the message through the flow fails in an exception strategy
MuleEvent	getMuleEvent()
MuleEvent	routeEvent(MuleEvent muleEvent) Routes the MuleEvent through the processors chain
void	sendFailureResponseToClient(MessagingException messagingException, ResponseCompletionCallback responseCompletionCallback)
void	sendResponseToClient(MuleEvent muleEvent, ResponseCompletionCallback responseCompletionCallback) Template method to send a response after processing the message.

Method Detail

getMuleEvent

MuleEvent getMuleEvent()
                       throws MuleException

Returns:

a MuleEvent created from the original message

Throws:

MuleException

routeEvent

MuleEvent routeEvent(MuleEvent muleEvent)
                     throws MuleException

Routes the MuleEvent through the processors chain

Parameters:

muleEvent - MuleEvent created from the raw message of this context

Returns:

the response MuleEvent

Throws:

MuleException

afterFailureProcessingFlow

void afterFailureProcessingFlow(Exception exception)

Call when the processing of the message through the flow fails in an exception strategy

Parameters:

exception -

sendResponseToClient

void sendResponseToClient(MuleEvent muleEvent,
                        ResponseCompletionCallback responseCompletionCallback)
                          throws MuleException

Template method to send a response after processing the message.

This method is executed within the flow so if it fails it will trigger the exception strategy.

Parameters:

muleEvent - the event with the content of the response to be sent.

responseCompletionCallback - callback to be used for notifying the result of the operation

Throws:

MuleException - exception thrown when processing the message to send the response. If there's a failure when writing the response using the underlying transport or connector then the exception to throw must be a ResponseDispatchException.

sendFailureResponseToClient

void sendFailureResponseToClient(MessagingException messagingException,
                               ResponseCompletionCallback responseCompletionCallback)
                                 throws MuleException

Parameters:

messagingException - exception thrown during the flow execution.

responseCompletionCallback - callback to be used for notifying the result of the operation

Throws:

MuleException - exception thrown when processing the message to send the response.