org.mule.runtime.api.meta.model.source

Interface SourceModel

All Superinterfaces:

ComponentModel, ComposableModel, ConnectableComponentModel, DeprecableModel, DescribedObject, EnrichableModel, HasDisplayModel, HasNotifications, HasOutputModel, HasSemanticTerms, HasStereotypeModel, NamedObject, ParameterizedModel, ThrowsErrors

@NoImplement
public interface SourceModel
extends ConnectableComponentModel, HasNotifications

A definition of a message source in an ExtensionModel.

Source models implement the flyweight pattern. This means that a given operation should only be represented by only one instance of this class. Thus, if the same operation is contained by different HasSourceModels instances, then each of those containers should reference the same operation model instance.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default void	accept(ComponentModelVisitor visitor) Accepts a ComponentModelVisitor
default List<ParameterModel>	getAllParameterModels() Returns all the ParameterModel on all groups, including the ones declared on the success and error callbacks.
Optional<SourceCallbackModel>	getErrorCallback() Optionally returns a SourceCallbackModel which will listen for errors thrown by the source owner each time it fails to process any of the generated messages
Optional<SourceCallbackModel>	getSuccessCallback() Optionally returns a SourceCallbackModel which will listen for the values produced by the source owner each time it successfully processes any of the generated messages.
Optional<SourceCallbackModel>	getTerminateCallback() Optionally returns a SourceCallbackModel which will listen for the results of every generated message.
boolean	hasResponse()
boolean	runsOnPrimaryNodeOnly()

Methods inherited from interface org.mule.runtime.api.meta.model.ConnectableComponentModel

isTransactional, requiresConnection, supportsStreaming

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getParameterGroupModels

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.ComposableModel

getNestedComponents

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel

getStereotype

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.error.ThrowsErrors

getErrorModels

Methods inherited from interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

getDeprecationModel, isDeprecated

Methods inherited from interface org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms

getSemanticTerms

Methods inherited from interface org.mule.runtime.api.meta.model.HasOutputModel

getOutput, getOutputAttributes, getSampleDataProviderModel

Methods inherited from interface org.mule.runtime.api.meta.model.notification.HasNotifications

getNotificationModels

Method Detail

hasResponse

boolean hasResponse()

Returns:

Whether the declared source emits a response

getSuccessCallback

Optional<SourceCallbackModel> getSuccessCallback()

Optionally returns a SourceCallbackModel which will listen for the values produced by the source owner each time it successfully processes any of the generated messages.

Returns:

an Optional SourceCallbackModel

getErrorCallback

Optional<SourceCallbackModel> getErrorCallback()

Optionally returns a SourceCallbackModel which will listen for errors thrown by the source owner each time it fails to process any of the generated messages

Returns:

an Optional SourceCallbackModel

getTerminateCallback

Optional<SourceCallbackModel> getTerminateCallback()

Optionally returns a SourceCallbackModel which will listen for the results of every generated message. This callback will be called after the getErrorCallback() and getSuccessCallback() as the last step to validate the result of the flow processing.

Returns:

an Optional SourceCallbackModel

runsOnPrimaryNodeOnly

boolean runsOnPrimaryNodeOnly()

Returns:

Whether the declared source should only run in the primary node when in cluster mode

getAllParameterModels

default List<ParameterModel> getAllParameterModels()

Returns all the ParameterModel on all groups, including the ones declared on the success and error callbacks. Parameters repeated among callbacks will be deduplicated.

Specified by:

getAllParameterModels in interface ParameterizedModel

Returns:

a flattened list of all the parameters in this model

accept

default void accept(ComponentModelVisitor visitor)

Accepts a ComponentModelVisitor

Specified by:

accept in interface ComponentModel

Parameters:

visitor - a ComponentModelVisitor