org.mule.extension.internal.sources

Class BaseSource<T,A>

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<T,A>

org.mule.extension.internal.sources.BaseSource<T,A>

Type Parameters:

T - type of input content.

A - type of input attributes.

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable

Direct Known Subclasses:

EntityCollectionSource, EntitySource

public abstract class BaseSource<T,A>
extends org.mule.runtime.extension.api.runtime.source.Source<T,A>
implements org.mule.runtime.api.lifecycle.Initialisable

Base class that implements the logic for listener flows sources.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExpansionParameters	expansionParameters
protected org.mule.runtime.api.component.location.ComponentLocation	location
protected ODataConfig	odataConfig
protected String	ROUTING_CONTEXT_KEY
protected ConfigurationRoutingKey	routingKey
protected SystemQueryOptionsParameters	systemQueryOptionsParameters Set of supported system query options.

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
BaseSource()

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.api.metadata.TypedValue<T>	convert(org.mule.runtime.api.metadata.TypedValue<?> payload, Class<T> outputClazz, org.mule.runtime.api.metadata.MediaType mediaType)
protected abstract org.slf4j.Logger	getLogger()
protected DefaultRoutingContext	getRoutingContext(org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)
protected abstract RoutingKey<T,A,SourceConfiguration>	getRoutingKey()
protected RoutingManager	getRoutingManager()
void	initialise()
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)
void	onStart(org.mule.runtime.extension.api.runtime.source.SourceCallback<T,A> sourceCallback)
void	onStop()
protected void	onSuccess(SuccessResponse successResponse, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext, org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback) Base implementation for OnSuccess, derived classes SHOULD call this on their
void	onTerminate(org.mule.runtime.extension.api.runtime.source.SourceResult sourceResult)

Methods inherited from class java.lang.Object

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

Field Detail

ROUTING_CONTEXT_KEY

protected final String ROUTING_CONTEXT_KEY

See Also:

Constant Field Values

odataConfig

@Config
protected ODataConfig odataConfig

routingKey

@MetadataKeyId
 @ParameterGroup(name="routingKey")
protected ConfigurationRoutingKey routingKey

expansionParameters

@ParameterGroup(name="Expansion parameters",
                showInDsl=true)
 @Summary(value="Set of $expansion-related parameters")
 @NullSafe
 @Expression(value=NOT_SUPPORTED)
protected ExpansionParameters expansionParameters

systemQueryOptionsParameters

@ParameterGroup(name="Supported System Query Options",
                showInDsl=true)
 @Summary(value="Set of supported system query options")
 @NullSafe
 @Expression(value=NOT_SUPPORTED)
protected SystemQueryOptionsParameters systemQueryOptionsParameters

Set of supported system query options.

location

protected org.mule.runtime.api.component.location.ComponentLocation location

Constructor Detail

BaseSource

public BaseSource()

Method Detail

getRoutingManager

protected RoutingManager getRoutingManager()

onStart

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

Specified by:

onStart in class org.mule.runtime.extension.api.runtime.source.Source<T,A>

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)

onStop

public void onStop()

Specified by:

onStop in class org.mule.runtime.extension.api.runtime.source.Source<T,A>

onTerminate

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

getRoutingContext

protected DefaultRoutingContext getRoutingContext(org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getRoutingKey

protected abstract RoutingKey<T,A,SourceConfiguration> getRoutingKey()

getLogger

protected abstract org.slf4j.Logger getLogger()

onSuccess

protected void onSuccess(SuccessResponse successResponse,
                         org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext,
                         org.mule.runtime.extension.api.runtime.source.SourceCompletionCallback completionCallback)

Base implementation for OnSuccess, derived classes SHOULD call this on their

 @OnSuccess<
 

implementations.

Parameters:

successResponse - The response that will be sent

callbackContext - Context to correlate the response to its original message

completionCallback - Callback to signal the completion of this async operation

convert

protected org.mule.runtime.api.metadata.TypedValue<T> convert(org.mule.runtime.api.metadata.TypedValue<?> payload,
                                                              Class<T> outputClazz,
                                                              org.mule.runtime.api.metadata.MediaType mediaType)