org.mule.runtime.extension.api.runtime.source

Interface SourceCallback<T,A>

Type Parameters:

T - the generic type of the output values of the generated results

A - the generic type of the attributes of the generated results

public interface SourceCallback<T,A>

A callback to allow Source implementations to communicate generated messages back to the runtime so that they can be processed.

Those messages will be represented as Result objects using the handle(Result) or handle(Result, SourceCallbackContext) methods.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
SourceCallbackContext	createContext()
void	handle(Result<T,A> result) Passes the given result back to the runtime for processing.
void	handle(Result<T,A> result, SourceCallbackContext context) Passes the given result back to the runtime for processing.
void	onSourceException(Throwable t) Any started Source must use this method to communicate the runtime that an exception was found trying to produce messages.

Method Detail

handle

void handle(Result<T,A> result)

Passes the given result back to the runtime for processing.

Parameters:

result - a Result

handle

void handle(Result<T,A> result,
            SourceCallbackContext context)

Passes the given result back to the runtime for processing. This method also allows providing a SourceCallbackContext so that state can be associated to each result.

This is specially helpful for sources which emits responses on stateful connections or which require to pass back some kind of token or identifier. Notice that this is not the only possible use case though.

The context instance should be created using the createContext() of this same instance

Parameters:

result - a Result

context - context a SourceCallbackContext

onSourceException

void onSourceException(Throwable t)

Any started Source must use this method to communicate the runtime that an exception was found trying to produce messages. Any exceptions that the source encounters trying to produce messages needs to be channeled through this method and NOT be thrown.

Do not confuse the concept of 'exception found producing a message' from a message which failed to be processed by the flow or an exception thrown by a method annotated with OnSuccess or OnError. Any of those represent an expected processing failure and need to be treated accordingly by the source itself. Those are not something that the runtime should be notified about.

Parameters:

t - a Throwable

createContext

SourceCallbackContext createContext()

Returns:

a new instance of SourceCallbackContext, only valid for use on this same SourceCallback instance