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

Class JavaOperationModelParser

java.lang.Object

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

All Implemented Interfaces:

AdditionalPropertiesModelParser, ComponentVisibilityParser, NotificationEmitterParser, OperationModelParser, SemanticTermsParser, StereotypeModelParser

public class JavaOperationModelParser
extends Object
implements OperationModelParser

OperationModelParser for Java based syntax

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.mule.runtime.api.meta.model.ModelProperty>	additionalModelProperties
protected boolean	connected
protected ExtensionElement	extensionElement
protected org.mule.runtime.extension.api.loader.ExtensionLoadingContext	loadingContext
protected OutputModelParser	outputAttributesType
protected OutputModelParser	outputType
protected boolean	supportsStreaming
protected boolean	transactional

Constructor Summary

Constructors

Constructor and Description
JavaOperationModelParser(JavaExtensionModelParser extensionModelParser, ExtensionElement extensionElement, OperationContainerElement operationContainer, OperationElement operationElement, org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties() Returns a list with all the model properties to be applied at the extension level which are specifically linked to the type of syntax used to define the extension.
OutputModelParser	getAttributesOutputType()
protected String	getComponentTypeName() Returns a meaningful name which describes the type of component being parsed.
org.mule.runtime.api.meta.model.ComponentVisibility	getComponentVisibility()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
Stream<org.mule.runtime.api.meta.model.notification.NotificationModel>	getEmittedNotificationsStream(Function<String,Optional<org.mule.runtime.api.meta.model.notification.NotificationModel>> notificationMapper) Gets a Stream with the parsed emitted NotificationModels.
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.
Set<String>	getSemanticTerms()
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
Optional<org.mule.runtime.api.meta.model.stereotype.StereotypeModel>	getStereotype(StereotypeModelFactory factory)
boolean	hasConfig()
int	hashCode()
boolean	isAutoPaging() Returns whether this operation supports auto paging.
boolean	isBlocking()
boolean	isConnected()
boolean	isIgnored()
boolean	isRouter()
boolean	isScope()
boolean	isTransactional()
protected void	parseComponentByteStreaming(WithAnnotations element) Parses the component's byte streaming attributes and extract's the appropriate values
protected void	parseComponentConnectivity(WithParameters component) Parses the component's connectivity attributes and extract's the appropriate values
boolean	supportsStreaming()

Methods inherited from class java.lang.Object

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

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

getAttributesOutputType, getOutputType, isConnected, isTransactional, supportsStreaming

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

getAdditionalModelProperties

Field Detail

outputType

protected OutputModelParser outputType

outputAttributesType

protected OutputModelParser outputAttributesType

supportsStreaming

protected boolean supportsStreaming

connected

protected boolean connected

transactional

protected boolean transactional

extensionElement

protected final ExtensionElement extensionElement

loadingContext

protected final org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext

additionalModelProperties

protected final List<org.mule.runtime.api.meta.model.ModelProperty> additionalModelProperties

Constructor Detail

JavaOperationModelParser

public JavaOperationModelParser(JavaExtensionModelParser extensionModelParser,
                                ExtensionElement extensionElement,
                                OperationContainerElement operationContainer,
                                OperationElement operationElement,
                                org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext)

Method Detail

getName

public String getName()

Specified by:

getName in interface OperationModelParser

Returns:

The parsed component's name

getDescription

public String getDescription()

Specified by:

getDescription in interface OperationModelParser

Returns:

the operation's description

getParameterGroupModelParsers

public List<ParameterGroupModelParser> getParameterGroupModelParsers()

Description copied from interface: OperationModelParser

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.

Specified by:

getParameterGroupModelParsers in interface OperationModelParser

Returns:

a list with the config's ParameterGroupModelParser

getNestedRouteParsers

public List<NestedRouteModelParser> getNestedRouteParsers()

Description copied from interface: OperationModelParser

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 OperationModelParser.isRouter() returns true. The list will be empty otherwise.

Specified by:

getNestedRouteParsers in interface OperationModelParser

Returns:

a list with the operation's NestedRouteModelParser

getNestedChainParser

public Optional<NestedChainModelParser> getNestedChainParser()

Description copied from interface: OperationModelParser

Returns an NestedChainModelParser if the operation defined one.

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

Specified by:

getNestedChainParser in interface OperationModelParser

Returns:

an Optional NestedChainModelParser

getExecutorModelProperty

public Optional<CompletableComponentExecutorModelProperty> getExecutorModelProperty()

Description copied from interface: OperationModelParser

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

Specified by:

getExecutorModelProperty in interface OperationModelParser

Returns:

a CompletableComponentExecutorModelProperty

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface OperationModelParser

Returns:

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

isScope

public boolean isScope()

Specified by:

isScope in interface OperationModelParser

Returns:

whether this operation represents a scope operation

isRouter

public boolean isRouter()

Specified by:

isRouter in interface OperationModelParser

Returns:

whether this operation represents a router

isAutoPaging

public boolean isAutoPaging()

Description copied from interface: OperationModelParser

Returns whether this operation supports auto paging.

If this method returns true, so will OperationModelParser.supportsStreaming()

Specified by:

isAutoPaging in interface OperationModelParser

Returns:

whether this operation supports auto paging.

getExecutionType

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

Specified by:

getExecutionType in interface OperationModelParser

Returns:

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

getMediaTypeModelProperty

public Optional<MediaTypeModelProperty> getMediaTypeModelProperty()

Specified by:

getMediaTypeModelProperty in interface OperationModelParser

Returns:

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

getExceptionHandlerModelProperty

public Optional<ExceptionHandlerModelProperty> getExceptionHandlerModelProperty()

Specified by:

getExceptionHandlerModelProperty in interface OperationModelParser

Returns:

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

getSinceMuleVersionModelProperty

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

Specified by:

getSinceMuleVersionModelProperty in interface OperationModelParser

isBlocking

public boolean isBlocking()

Specified by:

isBlocking in interface OperationModelParser

Returns:

whether the operation is blocking or non-blocking

hasConfig

public boolean hasConfig()

Specified by:

hasConfig in interface OperationModelParser

Returns:

whether this operation requires a configuration object to function

getErrorModelParsers

public List<ErrorModelParser> getErrorModelParsers()

Specified by:

getErrorModelParsers in interface OperationModelParser

Returns:

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

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface SemanticTermsParser

Returns:

a Set with the model's semantic terms

getEmittedNotificationsStream

public Stream<org.mule.runtime.api.meta.model.notification.NotificationModel> getEmittedNotificationsStream(Function<String,Optional<org.mule.runtime.api.meta.model.notification.NotificationModel>> notificationMapper)

Description copied from interface: NotificationEmitterParser

Gets a Stream with the parsed emitted NotificationModels.

Specified by:

getEmittedNotificationsStream in interface NotificationEmitterParser

Parameters:

notificationMapper - If the parser can only obtain a String from the DSL, it should apply this function to convert them to the corresponding NotificationModel. If the parser can get the corresponding NotificationModel by itself, this function shouldn't be applied.

Returns:

a Stream with the parsed emitted NotificationModels.

getComponentTypeName

protected String getComponentTypeName()

Returns a meaningful name which describes the type of component being parsed. Used for logging and error message generation

Returns:

the name of the parsed component type

getDeprecationModel

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

Specified by:

getDeprecationModel in interface OperationModelParser

Returns:

the operation's DeprecationModel if one was defined

getDisplayModel

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

Specified by:

getDisplayModel in interface OperationModelParser

Returns:

the operation's DisplayModel

getComponentVisibility

public org.mule.runtime.api.meta.model.ComponentVisibility getComponentVisibility()

Specified by:

getComponentVisibility in interface ComponentVisibilityParser

Returns:

the operation's ComponentVisibility.

getStereotype

public Optional<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> getStereotype(StereotypeModelFactory factory)

Specified by:

getStereotype in interface StereotypeModelParser

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseComponentConnectivity

protected void parseComponentConnectivity(WithParameters component)

Parses the component's connectivity attributes and extract's the appropriate values

Parameters:

component - the connected component

parseComponentByteStreaming

protected void parseComponentByteStreaming(WithAnnotations element)

Parses the component's byte streaming attributes and extract's the appropriate values

Parameters:

element - the connected component

getOutputType

public OutputModelParser getOutputType()

getAttributesOutputType

public OutputModelParser getAttributesOutputType()

supportsStreaming

public boolean supportsStreaming()

isConnected

public boolean isConnected()

isTransactional

public boolean isTransactional()

getAdditionalModelProperties

public final List<org.mule.runtime.api.meta.model.ModelProperty> getAdditionalModelProperties()

Returns a list with all the model properties to be applied at the extension level which are specifically linked to the type of syntax used to define the extension.

Specified by:

getAdditionalModelProperties in interface AdditionalPropertiesModelParser

Returns:

a list with ModelProperty instances.