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

Class MuleSdkExtensionModelParser

java.lang.Object

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

All Implemented Interfaces:

AdditionalPropertiesModelParser, ExtensionModelParser

Direct Known Subclasses:

MuleSdkApplicationExtensionModelParser, MuleSdkPluginExtensionModelParser

public abstract class MuleSdkExtensionModelParser
extends Object
implements ExtensionModelParser

ExtensionModelParser implementation for Mule SDK extensions

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEPRECATED_CONSTRUCT_NAME

Constructor Summary

Constructors

Constructor and Description
MuleSdkExtensionModelParser(org.mule.runtime.ast.api.ArtifactAst ast, org.mule.metadata.api.TypeLoader typeLoader, org.mule.runtime.ast.internal.model.ExtensionModelHelper extensionModelHelper)

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.api.meta.model.deprecated.DeprecationModel	buildDeprecationModel(org.mule.runtime.ast.api.ComponentAst deprecationAst) Builds a deprecation model by parsing the content of the deprecated parameter AST.
protected org.mule.runtime.module.extension.mule.internal.loader.parser.MuleSdkOperationModelParser	createOperationModelParser(org.mule.runtime.ast.api.ComponentAst operation, String namespace)
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties()
protected Stream<org.mule.runtime.ast.api.ComponentAst>	getChildren(org.mule.runtime.ast.api.ComponentAst component, String childName)
List<ConfigurationModelParser>	getConfigurationParsers()
List<ConnectionProviderModelParser>	getConnectionProviderModelParsers()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
List<ErrorModelParser>	getErrorModelParsers()
List<String>	getExportedResources()
List<org.mule.metadata.api.model.MetadataType>	getExportedTypes()
Optional<ExceptionHandlerModelProperty>	getExtensionHandlerModelProperty()
List<org.mule.runtime.api.meta.model.ExternalLibraryModel>	getExternalLibraryModels()
List<FunctionModelParser>	getFunctionModelParsers()
List<org.mule.metadata.api.model.MetadataType>	getImportedTypes()
List<org.mule.runtime.api.meta.model.notification.NotificationModel>	getNotificationModels()
List<OperationModelParser>	getOperationModelParsers()
protected <T> Optional<T>	getOptionalParameter(org.mule.runtime.ast.api.ComponentAst ast, String paramName) Returns the value of an optional parameter in the give ast.
protected <T> T	getParameter(org.mule.runtime.ast.api.ComponentAst ast, String paramName) Returns the value of a parameter in the given ast.
List<String>	getPrivilegedExportedArtifacts()
List<String>	getPrivilegedExportedPackages()
protected org.mule.runtime.ast.api.ComponentAst	getRequiredTopLevelComponent(org.mule.runtime.ast.api.ArtifactAst ast, org.mule.runtime.api.component.ComponentIdentifier childIdentifier)
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
protected Optional<org.mule.runtime.ast.api.ComponentAst>	getSingleChild(org.mule.runtime.ast.api.ComponentAst component, String childName)
List<SourceModelParser>	getSourceModelParsers()
Map<org.mule.metadata.api.model.MetadataType,List<org.mule.metadata.api.model.MetadataType>>	getSubTypes()
protected abstract Stream<org.mule.runtime.ast.api.ComponentAst>	getTopLevelElements(org.mule.runtime.ast.api.ArtifactAst ast)
protected void	init(org.mule.runtime.ast.api.ArtifactAst ast)

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.module.extension.internal.loader.parser.ExtensionModelParser

getCategory, getLicenseModelProperty, getName, getNamespace, getVendor, getXmlDslConfiguration

Field Detail

DEPRECATED_CONSTRUCT_NAME

protected static final String DEPRECATED_CONSTRUCT_NAME

See Also:

Constant Field Values

Constructor Detail

MuleSdkExtensionModelParser

public MuleSdkExtensionModelParser(org.mule.runtime.ast.api.ArtifactAst ast,
                                   org.mule.metadata.api.TypeLoader typeLoader,
                                   org.mule.runtime.ast.internal.model.ExtensionModelHelper extensionModelHelper)

Method Detail

init

protected void init(org.mule.runtime.ast.api.ArtifactAst ast)

getAdditionalModelProperties

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

Specified by:

getAdditionalModelProperties in interface AdditionalPropertiesModelParser

getConfigurationParsers

public List<ConfigurationModelParser> getConfigurationParsers()

Specified by:

getConfigurationParsers in interface ExtensionModelParser

getOperationModelParsers

public List<OperationModelParser> getOperationModelParsers()

Specified by:

getOperationModelParsers in interface ExtensionModelParser

getSourceModelParsers

public List<SourceModelParser> getSourceModelParsers()

Specified by:

getSourceModelParsers in interface ExtensionModelParser

getConnectionProviderModelParsers

public List<ConnectionProviderModelParser> getConnectionProviderModelParsers()

Specified by:

getConnectionProviderModelParsers in interface ExtensionModelParser

getFunctionModelParsers

public List<FunctionModelParser> getFunctionModelParsers()

Specified by:

getFunctionModelParsers in interface ExtensionModelParser

getErrorModelParsers

public List<ErrorModelParser> getErrorModelParsers()

Specified by:

getErrorModelParsers in interface ExtensionModelParser

getExternalLibraryModels

public List<org.mule.runtime.api.meta.model.ExternalLibraryModel> getExternalLibraryModels()

Specified by:

getExternalLibraryModels in interface ExtensionModelParser

getExtensionHandlerModelProperty

public Optional<ExceptionHandlerModelProperty> getExtensionHandlerModelProperty()

Specified by:

getExtensionHandlerModelProperty in interface ExtensionModelParser

getDeprecationModel

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

Specified by:

getDeprecationModel in interface ExtensionModelParser

getExportedTypes

public List<org.mule.metadata.api.model.MetadataType> getExportedTypes()

Specified by:

getExportedTypes in interface ExtensionModelParser

getExportedResources

public List<String> getExportedResources()

Specified by:

getExportedResources in interface ExtensionModelParser

getImportedTypes

public List<org.mule.metadata.api.model.MetadataType> getImportedTypes()

Specified by:

getImportedTypes in interface ExtensionModelParser

getPrivilegedExportedArtifacts

public List<String> getPrivilegedExportedArtifacts()

Specified by:

getPrivilegedExportedArtifacts in interface ExtensionModelParser

getPrivilegedExportedPackages

public List<String> getPrivilegedExportedPackages()

Specified by:

getPrivilegedExportedPackages in interface ExtensionModelParser

getSubTypes

public Map<org.mule.metadata.api.model.MetadataType,List<org.mule.metadata.api.model.MetadataType>> getSubTypes()

Specified by:

getSubTypes in interface ExtensionModelParser

getNotificationModels

public List<org.mule.runtime.api.meta.model.notification.NotificationModel> getNotificationModels()

Specified by:

getNotificationModels in interface ExtensionModelParser

getSinceMuleVersionModelProperty

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

Specified by:

getSinceMuleVersionModelProperty in interface ExtensionModelParser

getTopLevelElements

protected abstract Stream<org.mule.runtime.ast.api.ComponentAst> getTopLevelElements(org.mule.runtime.ast.api.ArtifactAst ast)

Parameters:

ast - the ArtifactAst representing the extension.

Returns:

a Stream with the top level elements ComponentAst extracted from the ast.

createOperationModelParser

protected org.mule.runtime.module.extension.mule.internal.loader.parser.MuleSdkOperationModelParser createOperationModelParser(org.mule.runtime.ast.api.ComponentAst operation,
                                                                                                                               String namespace)

getParameter

protected <T> T getParameter(org.mule.runtime.ast.api.ComponentAst ast,
                             String paramName)

Returns the value of a parameter in the given ast. The parameter is assumed to either be required or have a default defined.

Type Parameters:

T - the param's generic type

Parameters:

ast - a ComponentAst

paramName - the name of the parameter

Returns:

The parameter value

getOptionalParameter

protected <T> Optional<T> getOptionalParameter(org.mule.runtime.ast.api.ComponentAst ast,
                                               String paramName)

Returns the value of an optional parameter in the give ast.

Type Parameters:

T - the param's generic type

Parameters:

ast - a ComponentAst

paramName - the name of the parameter

Returns:

an Optional for the parameter's value

getChildren

protected Stream<org.mule.runtime.ast.api.ComponentAst> getChildren(org.mule.runtime.ast.api.ComponentAst component,
                                                                    String childName)

Parameters:

component - a ComponentAst

childName - the child element name

Returns:

A Stream with all the direct children with the given childName

getSingleChild

protected Optional<org.mule.runtime.ast.api.ComponentAst> getSingleChild(org.mule.runtime.ast.api.ComponentAst component,
                                                                         String childName)

Parameters:

component - a ComponentAst

childName - the child element name

Returns:

The first direct child (if any) with the given childName

getRequiredTopLevelComponent

protected org.mule.runtime.ast.api.ComponentAst getRequiredTopLevelComponent(org.mule.runtime.ast.api.ArtifactAst ast,
                                                                             org.mule.runtime.api.component.ComponentIdentifier childIdentifier)

Parameters:

ast - a ComponentAst

childIdentifier - the child ComponentIdentifier

Returns:

The first top level component with the given childIdentifier

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if not found.

buildDeprecationModel

protected org.mule.runtime.api.meta.model.deprecated.DeprecationModel buildDeprecationModel(org.mule.runtime.ast.api.ComponentAst deprecationAst)

Builds a deprecation model by parsing the content of the deprecated parameter AST.

Parameters:

deprecationAst - The deprecation parameter AST.

Returns:

The corresponding DeprecationModel.