org.mule.runtime.api.meta.model.declaration.fluent

Class SourceDeclarer

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.Declarer<D>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclarer<T,D>

org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer<T,D>

org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclarer<SourceDeclarer,SourceDeclaration>

org.mule.runtime.api.meta.model.declaration.fluent.SourceDeclarer

All Implemented Interfaces:

HasDeprecatedDeclarer<SourceDeclarer>, HasModelProperties<SourceDeclarer>, HasNestedComponentsDeclarer, HasNestedRoutesDeclarer, HasParametersDeclarer, HasSemanticTermsDeclarer<SourceDeclarer>, HasStereotypeDeclarer<SourceDeclarer>

public class SourceDeclarer
extends ExecutableComponentDeclarer<SourceDeclarer,SourceDeclaration>

Allows configuring a SourceDeclaration through a fluent API

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

declaration

Method Summary

Modifier and Type	Method and Description
SourceDeclarer	hasResponse(boolean hasResponse) Allows to specify if the declared source emits responses
SourceCallbackDeclarer	onBackPressure() Allows to declare a callback which is triggered when the runtime applies back pressure on a message generated by the source
SourceCallbackDeclarer	onError() Allows to declare a callback which will listen for errors that occurred in the flow processing a Source generated message.
SourceCallbackDeclarer	onSuccess() Allows to declare a callback which will listen to all the successful results of the dispatched Source messages to the flow.
SourceCallbackDeclarer	onTerminate() Allows to declare a callback which will listen to all the results of the dispatched Source messages to the flow.
SourceDeclarer	runsOnPrimaryNodeOnly(boolean primaryNodeOnly) Allows to specify whether the declared source should only run in the primary node when in cluster mode

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclarer

requiresConnection, supportsStreaming, transactional, withNotificationModel, withOutput, withOutputAttributes

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer

withChain, withChain, withComponent, withDeprecation, withErrorModel, withModelProperty, withOptionalComponent, withRoute, withSemanticTerm, withStereotype

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclarer

describedAs, onDefaultParameterGroup, onParameterGroup

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

getDeclaration

Methods inherited from class java.lang.Object

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

Method Detail

hasResponse

public SourceDeclarer hasResponse(boolean hasResponse)

Allows to specify if the declared source emits responses

Parameters:

hasResponse - Whether the declared source emits a response

Returns:

this declarer

runsOnPrimaryNodeOnly

public SourceDeclarer runsOnPrimaryNodeOnly(boolean primaryNodeOnly)

Allows to specify whether the declared source should only run in the primary node when in cluster mode

Parameters:

primaryNodeOnly - whether to only run on the primary node or not

Returns:

this declarer

onSuccess

public SourceCallbackDeclarer onSuccess()

Allows to declare a callback which will listen to all the successful results of the dispatched Source messages to the flow.

Returns:

a SourceCallbackDeclarer

onError

public SourceCallbackDeclarer onError()

Allows to declare a callback which will listen for errors that occurred in the flow processing a Source generated message.

Returns:

a SourceCallbackDeclarer

onBackPressure

public SourceCallbackDeclarer onBackPressure()

Allows to declare a callback which is triggered when the runtime applies back pressure on a message generated by the source

Returns:

a SourceCallbackDeclarer

Since:

1.1

onTerminate

public SourceCallbackDeclarer onTerminate()

Allows to declare a callback which will listen to all the results of the dispatched Source messages to the flow. This callback will be called after the onSuccess() ()} and onError() callbacks.

Returns:

a SourceCallbackDeclarer