org.mule.execution

Interface RequestResponseFlowProcessingPhaseTemplate

All Superinterfaces:

FlowProcessingPhaseTemplate, MessageProcessTemplate

All Known Implementing Classes:

HttpMessageProcessTemplate, HttpsMessageProcessTemplate, JettyContinuationsMessageProcessTemplate, JettyMessageProcessTemplate

public interface RequestResponseFlowProcessingPhaseTemplate
extends FlowProcessingPhaseTemplate

Extension of FlowProcessingPhaseTemplate for those MessageSource that requires sending a response of the message processed.

Method Summary

Methods

Modifier and Type	Method and Description
void	sendFailureResponseToClient(MessagingException messagingException)
void	sendResponseToClient(MuleEvent muleEvent) Template method to send a response after processing the message.

Methods inherited from interface org.mule.execution.FlowProcessingPhaseTemplate

afterFailureProcessingFlow, afterFailureProcessingFlow, afterRouteEvent, afterSuccessfulProcessingFlow, beforeRouteEvent, getMuleEvent, getOriginalMessage, routeEvent

Method Detail

sendResponseToClient

void sendResponseToClient(MuleEvent muleEvent)
                          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.

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)
                                 throws MuleException

Parameters:

messagingException - exception thrown during the flow execution.

Throws:

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