org.mule.runtime.module.extension.internal.runtime.source

Interface SourceCompletionHandler

All Known Implementing Classes:

NullSourceCompletionHandler, SourceAdapter.DefaultSourceCompletionHandler

public interface SourceCompletionHandler

Handles the result of flow processing.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	createFailureResponseParameters(CoreEvent event) Resolves the set of parameters of the failure response function of the source against the supplied Event.
Map<String,Object>	createResponseParameters(CoreEvent event) Resolves the set of parameters of the response function of the source against the supplied Event.
void	onCompletion(CoreEvent event, Map<String,Object> parameters, org.mule.runtime.api.component.execution.CompletableCallback<Void> callback) Invoked on successful completion of flow processing.
void	onFailure(MessagingException exception, Map<String,Object> parameters, org.mule.runtime.api.component.execution.CompletableCallback<Void> callback) Invoked when a failure occurs during the flow processing
void	onTerminate(org.mule.runtime.api.functional.Either<MessagingException,CoreEvent> eventOrException)

Method Detail

onCompletion

void onCompletion(CoreEvent event,
                  Map<String,Object> parameters,
                  org.mule.runtime.api.component.execution.CompletableCallback<Void> callback)

Invoked on successful completion of flow processing.

Exceptions found while processing are to be notified through the exceptionCallback, which might (depending on HandledCompletionExceptionResult) produce a new value as the result of handling such error

Parameters:

event - the result of the flow execution

callback - the callback to be completed as a result

onFailure

void onFailure(MessagingException exception,
               Map<String,Object> parameters,
               org.mule.runtime.api.component.execution.CompletableCallback<Void> callback)

Invoked when a failure occurs during the flow processing

Parameters:

exception - the exception thrown during processing

callback - the callback to be completed as a result

onTerminate

void onTerminate(org.mule.runtime.api.functional.Either<MessagingException,CoreEvent> eventOrException)
          throws Exception

Throws:

Exception

createResponseParameters

Map<String,Object> createResponseParameters(CoreEvent event)
                                     throws MessagingException

Resolves the set of parameters of the response function of the source against the supplied Event.

Parameters:

event - the Event with the result of the successful flow processing.

Returns:

the response function parameters with it's values.

Throws:

MessagingException

createFailureResponseParameters

Map<String,Object> createFailureResponseParameters(CoreEvent event)
                                            throws MessagingException

Resolves the set of parameters of the failure response function of the source against the supplied Event.

Parameters:

event - the Event with the result of the failed flow processing.

Returns:

the failed response function parameters with it's values.

Throws:

MessagingException