org.mule.runtime.core.execution

Interface ModuleFlowProcessingPhaseTemplate

All Superinterfaces:

MessageProcessTemplate, MessageSourceResponseParametersProcessor

public interface ModuleFlowProcessingPhaseTemplate
extends MessageProcessTemplate, MessageSourceResponseParametersProcessor

Template methods for MessageSource specific behavior during flow execution.

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.message.Message	getMessage()
Event	routeEvent(Event event) Routes the Event through the processors chain
org.reactivestreams.Publisher<Event>	routeEventAsync(Event event) Routes the Event through the processors chain using async API.
void	sendAfterTerminateResponseToClient(Either<MessagingException,Event> either)
org.reactivestreams.Publisher<Void>	sendFailureResponseToClient(MessagingException exception, Map<String,Object> parameters, ResponseCompletionCallback responseCompletionCallback)
org.reactivestreams.Publisher<Void>	sendResponseToClient(Event flowExecutionResponse, Map<String,Object> parameters, Function<Event,Map<String,Object>> errorResponseParametersFunction, ResponseCompletionCallback responseCompletionCallback) Template method to send a response after processing the message.

Methods inherited from interface org.mule.runtime.core.policy.MessageSourceResponseParametersProcessor

getFailedExecutionResponseParametersFunction, getSuccessfulExecutionResponseParametersFunction

Method Detail

getMessage

org.mule.runtime.api.message.Message getMessage()
                                         throws org.mule.runtime.api.exception.MuleException

Returns:

a Message 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

Returns:

the response Event

Throws:

org.mule.runtime.api.exception.MuleException

routeEventAsync

org.reactivestreams.Publisher<Event> routeEventAsync(Event event)

Routes the Event through the processors chain using async API.

Parameters:

event - Event created from the raw message of this context

Returns:

the Publisher that will ne siganlled on processing completion

sendResponseToClient

org.reactivestreams.Publisher<Void> sendResponseToClient(Event flowExecutionResponse,
                                                         Map<String,Object> parameters,
                                                         Function<Event,Map<String,Object>> errorResponseParametersFunction,
                                                         ResponseCompletionCallback responseCompletionCallback)

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:

flowExecutionResponse - the result of the flow execution

parameters - the resolved set of parameters required to send the response.

errorResponseParametersFunction - function that generates the error parameters to be sent in the case of a failure.

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

sendFailureResponseToClient

org.reactivestreams.Publisher<Void> sendFailureResponseToClient(MessagingException exception,
                                                                Map<String,Object> parameters,
                                                                ResponseCompletionCallback responseCompletionCallback)

Parameters:

exception - exception thrown during the flow execution.

parameters - the resolved set of parameters required to send the failure response.

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

sendAfterTerminateResponseToClient

void sendAfterTerminateResponseToClient(Either<MessagingException,Event> either)

Parameters:

either - that communicates the result of the flow execution.

• Event if the execution finished correctly
• MessagingException if an error occurred during the execution