org.mule.extension.internal.apikit

Class ApikitSource<InputPayload,InputAttr,Output>

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<InputPayload,InputAttr>

org.mule.extension.internal.apikit.ApikitSource<InputPayload,InputAttr,Output>

Type Parameters:

InputPayload - The type of payload to be pushed in the mule-flow

InputAttr - The type of attributes to be pushed in the mule-flow

Output - The type returned by the mule-flow execution

Direct Known Subclasses:

DataFetcherSource, DataLoaderSource

public abstract class ApikitSource<InputPayload,InputAttr,Output>
extends org.mule.runtime.extension.api.runtime.source.Source<InputPayload,InputAttr>

Extends Mule Source, handling the logic to be registered in a SourceExecutorRegistry discriminated by RoutingKey

Constructor Summary

Constructors

Constructor and Description
ApikitSource()

Method Summary

Modifier and Type	Method and Description
protected <T> org.mule.runtime.api.metadata.TypedValue<T>	convert(org.mule.runtime.api.metadata.TypedValue<Object> payload, org.mule.runtime.api.metadata.DataType dataType)
protected void	failure(Throwable error, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext, org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback) This method must be called by any failures generated by processing a response (@OnError handlers or errors during @OnSuccess)
protected abstract RoutingKey<InputPayload,InputAttr,Output>	getKey()
void	onError(org.mule.runtime.api.message.Error error, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext, org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback) When mule-flow execution ends with an error, the result is completed with the Error
void	onStart(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputPayload,InputAttr> sourceCallback) Creates a SourceExecutor to trigger the flow execution,and register the executor in SourceExecutorRegistry
void	onStop() Unregister the executor from SourceExecutorRegistry
void	onTerminate(org.mule.runtime.extension.api.runtime.source.SourceResult sourceResult) When mule-flow execution terminates, check if an error occurred
protected void	success(Output responseContent, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext, org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback) This method must be called by the @OnSuccess annotated method in the child class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApikitSource

public ApikitSource()

Method Detail

getKey

protected abstract RoutingKey<InputPayload,InputAttr,Output> getKey()

Returns:

the key that identifies the Source

success

protected void success(Output responseContent,
                       org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext,
                       org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback)

This method must be called by the @OnSuccess annotated method in the child class

Parameters:

responseContent - the content received from flow execution

callbackContext -

completionCallback -

failure

protected void failure(Throwable error,
                       org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext,
                       org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback)

This method must be called by any failures generated by processing a response (@OnError handlers or errors during @OnSuccess)

Parameters:

error - the exception that caused the failure received

callbackContext - the callback context for the message that failed its processing

completionCallback - the completion callback for the message

onStart

public void onStart(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputPayload,InputAttr> sourceCallback)

Creates a SourceExecutor to trigger the flow execution,and register the executor in SourceExecutorRegistry

Specified by:

onStart in class org.mule.runtime.extension.api.runtime.source.Source<InputPayload,InputAttr>

Parameters:

sourceCallback - provided by runtime to call the flow

onStop

public void onStop()

Unregister the executor from SourceExecutorRegistry

Specified by:

onStop in class org.mule.runtime.extension.api.runtime.source.Source<InputPayload,InputAttr>

onError

@OnError
public void onError(org.mule.runtime.api.message.Error error,
                             org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext,
                             org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback)

When mule-flow execution ends with an error, the result is completed with the Error

Parameters:

error -

callbackContext -

completionCallback -

onTerminate

@OnTerminate
public void onTerminate(org.mule.runtime.extension.api.runtime.source.SourceResult sourceResult)

When mule-flow execution terminates, check if an error occurred

Parameters:

sourceResult -

convert

protected <T> org.mule.runtime.api.metadata.TypedValue<T> convert(org.mule.runtime.api.metadata.TypedValue<Object> payload,
                                                                  org.mule.runtime.api.metadata.DataType dataType)