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

Class SourceDeclaration

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.NamedDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.StereotypedDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclaration<SourceDeclaration>

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

All Implemented Interfaces:

DescribedObject, WithNestedComponentsDeclaration<SourceDeclaration>, WithOutputDeclaration, WithParametersDeclaration, WithStereotypesDeclaration, NamedObject

public class SourceDeclaration
extends ExecutableComponentDeclaration<SourceDeclaration>

A declaration object for a SourceModel. It contains raw, unvalidated data which is used to declare the structure of a SourceModel

Since:

1.0

Method Summary

Modifier and Type	Method and Description
List<ParameterDeclaration>	getAllParameters() Returns all the parameter declarations declared on all groups, including the ones declared on the success and error callbacks
Optional<SourceCallbackDeclaration>	getBackPressureCallback()
Optional<SourceCallbackDeclaration>	getErrorCallback()
Optional<SourceCallbackDeclaration>	getSuccessCallback()
Optional<SourceCallbackDeclaration>	getTerminateCallback()
boolean	hasResponse()
boolean	isHasResponse()
boolean	isRunsOnPrimaryNodeOnly()
void	setBackPressureCallback(SourceCallbackDeclaration backPressureCallback) Sets the back pressure SourceCallbackDeclaration
void	setErrorCallback(SourceCallbackDeclaration errorCallback) Sets the error SourceCallbackDeclaration
void	setHasResponse(boolean hasResponse)
void	setRunsOnPrimaryNodeOnly(boolean runsOnPrimaryNodeOnly) Sets whether the declared source should only run in the primary node when in cluster mode
void	setSuccessCallback(SourceCallbackDeclaration successCallback) Sets the success SourceCallbackDeclaration
void	setTerminateCallback(SourceCallbackDeclaration terminateCallback) Sets the terminate SourceCallbackDeclaration

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

addNotificationModel, getNotificationModels, getOutput, getOutputAttributes, isRequiresConnection, isSupportsStreaming, isTransactional, setOutput, setOutputAttributes, setRequiresConnection, setSupportsStreaming, setTransactional

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

addErrorModel, addNestedComponent, getErrorModels, getNestedComponents

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

getStereotype, withStereotype

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

getParameterGroup, getParameterGroups

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

getName

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

addModelProperty, getDescription, getDisplayModel, getModelProperties, getModelProperty, setDescription, setDisplayModel

Methods inherited from class java.lang.Object

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

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

getStereotype, withStereotype

Method Detail

getAllParameters

public List<ParameterDeclaration> getAllParameters()

Returns all the parameter declarations declared on all groups, including the ones declared on the success and error callbacks

Specified by:

getAllParameters in interface WithParametersDeclaration

Overrides:

getAllParameters in class ParameterizedDeclaration<SourceDeclaration>

Returns:

a flattened list of all the parameters in this declaration

hasResponse

public boolean hasResponse()

Returns:

Whether the declared source emits a response

setHasResponse

public void setHasResponse(boolean hasResponse)

Parameters:

hasResponse - Whether the declared source emits a response

getSuccessCallback

public Optional<SourceCallbackDeclaration> getSuccessCallback()

Returns:

the success SourceCallbackDeclaration if provided.

setSuccessCallback

public void setSuccessCallback(SourceCallbackDeclaration successCallback)

Sets the success SourceCallbackDeclaration

Parameters:

successCallback - a callback declaration or null

getErrorCallback

public Optional<SourceCallbackDeclaration> getErrorCallback()

Returns:

the error SourceCallbackDeclaration if provided.

getBackPressureCallback

public Optional<SourceCallbackDeclaration> getBackPressureCallback()

Returns:

the back pressure SourceCallbackDeclaration if provided

Since:

1.1

setErrorCallback

public void setErrorCallback(SourceCallbackDeclaration errorCallback)

Sets the error SourceCallbackDeclaration

Parameters:

errorCallback - a callback declaration or null

getTerminateCallback

public Optional<SourceCallbackDeclaration> getTerminateCallback()

Returns:

the terminate SourceCallbackDeclaration if provided.

setTerminateCallback

public void setTerminateCallback(SourceCallbackDeclaration terminateCallback)

Sets the terminate SourceCallbackDeclaration

Parameters:

terminateCallback - a callback declaration or null

isHasResponse

public boolean isHasResponse()

isRunsOnPrimaryNodeOnly

public boolean isRunsOnPrimaryNodeOnly()

Returns:

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

setRunsOnPrimaryNodeOnly

public void setRunsOnPrimaryNodeOnly(boolean runsOnPrimaryNodeOnly)

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

Parameters:

runsOnPrimaryNodeOnly - whether to only run on the primary node

setBackPressureCallback

public void setBackPressureCallback(SourceCallbackDeclaration backPressureCallback)

Sets the back pressure SourceCallbackDeclaration

Parameters:

backPressureCallback - a callback declaration or null

Since:

1.1