org.mule.runtime.core.execution

Interface AsyncResponseFlowProcessingPhaseTemplate

All Superinterfaces:

MessageProcessTemplate

public interface AsyncResponseFlowProcessingPhaseTemplate
extends MessageProcessTemplate

Template methods for MessageSource specific behavior during flow execution.

Method Summary

Modifier and Type	Method and Description
Event	getEvent()
Event	routeEvent(Event event) Routes the Event through the processors chain
void	sendFailureResponseToClient(MessagingException exception, ResponseCompletionCallback responseCompletionCallback)
void	sendResponseToClient(Event event, ResponseCompletionCallback responseCompletionCallback) Template method to send a response after processing the message.

Method Detail

getEvent

Event getEvent()
        throws org.mule.runtime.api.exception.MuleException

Returns:

a Event created from the original message

Throws:

org.mule.runtime.api.exception.MuleException

routeEvent

Event routeEvent(Event event)
          throws org.mule.runtime.api.exception.MuleException

Routes the Event through the processors chain

Parameters:

event - Event created from the raw message of this context

event - Event created from the raw message of this context

Returns:

the response Event

Throws:

org.mule.runtime.api.exception.MuleException

org.mule.runtime.api.exception.MuleException

sendResponseToClient

void sendResponseToClient(Event event,
                          ResponseCompletionCallback responseCompletionCallback)
                   throws org.mule.runtime.api.exception.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:

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

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

Throws:

org.mule.runtime.api.exception.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 exception,
                                 ResponseCompletionCallback responseCompletionCallback)
                          throws org.mule.runtime.api.exception.MuleException

Parameters:

exception - exception thrown during the flow execution.

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

Throws:

org.mule.runtime.api.exception.MuleException - exception thrown when processing the message to send the response.