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

Interface OperationModelParser

All Superinterfaces:

AdditionalPropertiesModelParser, ComponentVisibilityParser, NotificationEmitterParser, SemanticTermsParser, StereotypeModelParser

All Known Implementing Classes:

JavaOperationModelParser

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

Parses the syntactic definition of a OperationModel 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

Method Summary

Modifier and Type	Method and Description
OutputModelParser	getAttributesOutputType()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
List<ErrorModelParser>	getErrorModelParsers()
Optional<ExceptionHandlerModelProperty>	getExceptionHandlerModelProperty()
Optional<org.mule.runtime.api.meta.model.operation.ExecutionType>	getExecutionType()
Optional<CompletableComponentExecutorModelProperty>	getExecutorModelProperty() Returns the CompletableComponentExecutorModelProperty which will be used to create the CompletableComponentExecutor that brings the operation to life.
Optional<MediaTypeModelProperty>	getMediaTypeModelProperty()
String	getName()
Optional<NestedChainModelParser>	getNestedChainParser() Returns an NestedChainModelParser if the operation defined one.
List<NestedRouteModelParser>	getNestedRouteParsers() Returns a list with a NestedRouteModelParser per each route defined in the operation.
OutputModelParser	getOutputType()
List<ParameterGroupModelParser>	getParameterGroupModelParsers() Returns a list with a ParameterGroupModelParser per each parameter group defined in the operation.
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
boolean	hasConfig()
boolean	isAutoPaging() Returns whether this operation supports auto paging.
boolean	isBlocking()
boolean	isConnected()
boolean	isIgnored()
boolean	isRouter()
boolean	isScope()
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.AdditionalPropertiesModelParser

getAdditionalModelProperties

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.NotificationEmitterParser

getEmittedNotificationsStream

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

getComponentVisibility

Method Detail

getName

String getName()

Returns:

the operation's name

getDescription

String getDescription()

Returns:

the operation's description

getOutputType

OutputModelParser getOutputType()

Returns:

an OutputModelParser describing the operation's output value

getAttributesOutputType

OutputModelParser getAttributesOutputType()

Returns:

an OutputModelParser describing the operation's output attributes

getParameterGroupModelParsers

List<ParameterGroupModelParser> getParameterGroupModelParsers()

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

Returns:

a list with the config's ParameterGroupModelParser

getNestedRouteParsers

List<NestedRouteModelParser> getNestedRouteParsers()

Returns a list with a NestedRouteModelParser per each route defined in the operation.

The Routes are listed in the same order as defined in the syntax.

This list will only be populated when isRouter() returns true. The list will be empty otherwise.

Returns:

a list with the operation's NestedRouteModelParser

getExecutorModelProperty

Optional<CompletableComponentExecutorModelProperty> getExecutorModelProperty()

Returns the CompletableComponentExecutorModelProperty which will be used to create the CompletableComponentExecutor that brings the operation to life.

Returns:

a CompletableComponentExecutorModelProperty

getNestedChainParser

Optional<NestedChainModelParser> getNestedChainParser()

Returns an NestedChainModelParser if the operation defined one.

The value will be present only if isScope() returns true

Returns:

an Optional NestedChainModelParser

isBlocking

boolean isBlocking()

Returns:

whether the operation is blocking or non-blocking

isIgnored

boolean isIgnored()

Returns:

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

isScope

boolean isScope()

Returns:

whether this operation represents a scope operation

isRouter

boolean isRouter()

Returns:

whether this operation represents a router

isConnected

boolean isConnected()

Returns:

whether this operation requires access to a connection to function

hasConfig

boolean hasConfig()

Returns:

whether this operation requires a configuration object 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

isAutoPaging

boolean isAutoPaging()

Returns whether this operation supports auto paging.

If this method returns true, so will supportsStreaming()

Returns:

whether this operation supports auto paging.

getExecutionType

Optional<org.mule.runtime.api.meta.model.operation.ExecutionType> getExecutionType()

Returns:

the operation's ExecutionType if one was defined. If no value present, Mule will infer one.

getMediaTypeModelProperty

Optional<MediaTypeModelProperty> getMediaTypeModelProperty()

Returns:

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

getExceptionHandlerModelProperty

Optional<ExceptionHandlerModelProperty> getExceptionHandlerModelProperty()

Returns:

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

getDeprecationModel

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

Returns:

the operation's DeprecationModel if one was defined

getDisplayModel

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

Returns:

the operation's DisplayModel

getErrorModelParsers

List<ErrorModelParser> getErrorModelParsers()

Returns:

a list with an ErrorModelParser per each error that the operation can raise.

getSinceMuleVersionModelProperty

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