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.ExecutableComponentDeclarer<SourceDeclarer,SourceDeclaration>

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

All Implemented Interfaces:

HasModelProperties<org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer>, HasNestedComponents, HasNestedRoutes, HasParametersDeclarer

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	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.
NestedChainDeclarer	withChain() Adds a component of the given name
NestedChainDeclarer	withChain(String chainName) Adds a component of the given name
NestedComponentDeclarer	withComponent(String nestedComponentName) Adds a component of the given name
T	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
NestedComponentDeclarer	withOptionalComponent(String nestedComponentName) Adds a component of the given name
NestedRouteDeclarer	withRoute(String routeName) Adds a component of the given name
T	withStereotype(StereotypeModel stereotype) Adds the given stereotype

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

requiresConnection, supportsStreaming, transactional, withErrorModel, withOutput, withOutputAttributes

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

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

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

withOptionalComponent

public NestedComponentDeclarer withOptionalComponent(String nestedComponentName)

Adds a component of the given name

Specified by:

withOptionalComponent in interface HasNestedComponents

Parameters:

nestedComponentName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withComponent

public NestedComponentDeclarer withComponent(String nestedComponentName)

Adds a component of the given name

Specified by:

withComponent in interface HasNestedComponents

Parameters:

nestedComponentName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withChain

public NestedChainDeclarer withChain()

Adds a component of the given name

Specified by:

withChain in interface HasNestedComponents

Returns:

a NestedComponentDeclarer which allows describing the created component

withChain

public NestedChainDeclarer withChain(String chainName)

Adds a component of the given name

Specified by:

withChain in interface HasNestedComponents

Parameters:

chainName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withRoute

public NestedRouteDeclarer withRoute(String routeName)

Adds a component of the given name

Specified by:

withRoute in interface HasNestedRoutes

Parameters:

routeName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withStereotype

public T withStereotype(StereotypeModel stereotype)

Adds the given stereotype

Parameters:

stereotype - a StereotypeModel

Returns:

this declarer

withModelProperty

public T withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer