org.mule.runtime.module.extension.internal.loader.parser

Interface SourceModelParser

All Superinterfaces:

AdditionalPropertiesModelParser, ComponentVisibilityParser, NotificationEmitterParser, SemanticTermsParser, StereotypeModelParser

All Known Implementing Classes:

JavaSourceModelParser

public interface SourceModelParser
extends SemanticTermsParser, StereotypeModelParser, AdditionalPropertiesModelParser, NotificationEmitterParser, ComponentVisibilityParser

Parses the syntactic definition of a SourceModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Since:

4.5.0

See Also:

ExtensionModelParser

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SourceModelParser.SourceCallbackModelParser Parses the syntactic definition of a SourceCallbackModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Method Summary

Modifier and Type	Method and Description
boolean	emitsResponse()
OutputModelParser	getAttributesOutputType()
Optional<org.mule.runtime.extension.api.property.BackPressureStrategyModelProperty>	getBackPressureStrategyModelProperty()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
Optional<ExceptionHandlerModelProperty>	getExceptionHandlerModelProperty()
Optional<MediaTypeModelProperty>	getMediaTypeModelProperty()
String	getName()
Optional<SourceModelParser.SourceCallbackModelParser>	getOnBackPressureCallbackParser()
Optional<SourceModelParser.SourceCallbackModelParser>	getOnErrorCallbackParser()
Optional<SourceModelParser.SourceCallbackModelParser>	getOnSuccessCallbackParser()
Optional<SourceModelParser.SourceCallbackModelParser>	getOnTerminateCallbackParser()
OutputModelParser	getOutputType()
List<ParameterGroupModelParser>	getParameterGroupModelParsers() Returns a list with a ParameterGroupModelParser per each parameter group defined in the source.
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
org.mule.runtime.extension.api.property.SourceClusterSupportModelProperty	getSourceClusterSupportModelProperty()
Optional<SdkSourceFactoryModelProperty>	getSourceFactoryModelProperty() Returns the SdkSourceFactoryModelProperty which will be used to create the SdkSourceFactory that brings the operation to life.
boolean	hasConfig()
boolean	isConnected()
boolean	isIgnored()
boolean	isTransactional()
boolean	supportsStreaming()

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.SemanticTermsParser

getSemanticTerms

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.StereotypeModelParser

getStereotype

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.AdditionalPropertiesModelParser

getAdditionalModelProperties

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.NotificationEmitterParser

getEmittedNotificationsStream

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.ComponentVisibilityParser

getComponentVisibility

Method Detail

getName

String getName()

Returns:

the source's name

getDescription

String getDescription()

Returns:

the source's description

getParameterGroupModelParsers

List<ParameterGroupModelParser> getParameterGroupModelParsers()

Returns a list with a ParameterGroupModelParser per each parameter group defined in the source. Each group is listed in the same order as defined in the syntax.

Returns:

a list with the config's ParameterGroupModelParser

getOutputType

OutputModelParser getOutputType()

Returns:

an OutputModelParser describing the operation's output value

getAttributesOutputType

OutputModelParser getAttributesOutputType()

Returns:

an OutputModelParser describing the operation's output attributes

getOnSuccessCallbackParser

Optional<SourceModelParser.SourceCallbackModelParser> getOnSuccessCallbackParser()

Returns:

a SourceModelParser.SourceCallbackModelParser for the success callback, if one was defined

getOnErrorCallbackParser

Optional<SourceModelParser.SourceCallbackModelParser> getOnErrorCallbackParser()

Returns:

a SourceModelParser.SourceCallbackModelParser for the error callback, if one was defined

getOnTerminateCallbackParser

Optional<SourceModelParser.SourceCallbackModelParser> getOnTerminateCallbackParser()

Returns:

a SourceModelParser.SourceCallbackModelParser for the terminate callback, if one was defined

getOnBackPressureCallbackParser

Optional<SourceModelParser.SourceCallbackModelParser> getOnBackPressureCallbackParser()

Returns:

a SourceModelParser.SourceCallbackModelParser for the back pressure callback, if one was defined

getSourceFactoryModelProperty

Optional<SdkSourceFactoryModelProperty> getSourceFactoryModelProperty()

Returns the SdkSourceFactoryModelProperty which will be used to create the SdkSourceFactory that brings the operation to life.

Returns:

a SdkSourceFactoryModelProperty

emitsResponse

boolean emitsResponse()

Returns:

whether this source emits responses

isIgnored

boolean isIgnored()

Returns:

whether this source should be ignored and excluded from the resulting ExtensionModel

isConnected

boolean isConnected()

Returns:

whether this source requires access to a connection to function

hasConfig

boolean hasConfig()

Returns:

whether this source requires access to a config to function

supportsStreaming

boolean supportsStreaming()

Returns:

whether this operation supports returning streamable payloads.

isTransactional

boolean isTransactional()

Returns:

whether this operation supports executing as part of a transaction

getMediaTypeModelProperty

Optional<MediaTypeModelProperty> getMediaTypeModelProperty()

Returns:

a MediaTypeModelProperty describing the source's output mimeType, if one was defined

getExceptionHandlerModelProperty

Optional<ExceptionHandlerModelProperty> getExceptionHandlerModelProperty()

Returns:

an Optional ExceptionHandlerModelProperty is an exception handler was defined for this source.

getDeprecationModel

Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()

Returns:

the source's DeprecationModel if one was defined

getDisplayModel

Optional<org.mule.runtime.api.meta.model.display.DisplayModel> getDisplayModel()

Returns:

the source's DisplayModel

getBackPressureStrategyModelProperty

Optional<org.mule.runtime.extension.api.property.BackPressureStrategyModelProperty> getBackPressureStrategyModelProperty()

Returns:

the back pressure support info for the source

getSourceClusterSupportModelProperty

org.mule.runtime.extension.api.property.SourceClusterSupportModelProperty getSourceClusterSupportModelProperty()

Returns:

the type of cluster support this source provides

getSinceMuleVersionModelProperty

Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty> getSinceMuleVersionModelProperty()