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

Interface ExtensionModelParser

All Superinterfaces:

AdditionalPropertiesModelParser

All Known Implementing Classes:

JavaExtensionModelParser

public interface ExtensionModelParser
extends AdditionalPropertiesModelParser

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

This parser also makes explicit the need for certain model properties which despite not being explicit in the ExtensionModel are a must for Mule to be able to execute the extension. A typical example of this is the OperationModelParser.getExecutorModelProperty(), which allows Mule to instantiate the CompletableComponentExecutor which will bring the operation to life.

This and all component parsers access through it (ConfigurationModelParser, OperationModelParser, etc) MUST implement Object.equals(Object) and Object.hashCode() so that two parseres which represent the SAME component or element are considered to be equal.

Since:

4.5.0

See Also:

ConfigurationModelParser, OperationModelParser, SourceModelParser, ConnectionProviderModelParser, FunctionModelParser, ParameterModelParser

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.meta.Category	getCategory()
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()
LicenseModelProperty	getLicenseModelProperty()
String	getName()
String	getNamespace()
List<org.mule.runtime.api.meta.model.notification.NotificationModel>	getNotificationModels()
List<OperationModelParser>	getOperationModelParsers()
List<String>	getPrivilegedExportedArtifacts()
List<String>	getPrivilegedExportedPackages()
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
List<SourceModelParser>	getSourceModelParsers()
Map<org.mule.metadata.api.model.MetadataType,List<org.mule.metadata.api.model.MetadataType>>	getSubTypes() The extension's subtype mappings.
String	getVendor()
Optional<XmlDslConfiguration>	getXmlDslConfiguration()

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

getAdditionalModelProperties

Method Detail

getName

String getName()

Returns:

The Extension's Name

getCategory

org.mule.runtime.api.meta.Category getCategory()

Returns:

The Extension's Category

getVendor

String getVendor()

Returns:

The Extension's Vendor

getConfigurationParsers

List<ConfigurationModelParser> getConfigurationParsers()

Returns:

a list with a ConfigurationModelParser per each configuration defined in the extension.

getOperationModelParsers

List<OperationModelParser> getOperationModelParsers()

Returns:

a list with a OperationModelParser per each operation defined in the extension.

getSourceModelParsers

List<SourceModelParser> getSourceModelParsers()

Returns:

a list with a SourceModelParser per each event source defined in the extension.

getConnectionProviderModelParsers

List<ConnectionProviderModelParser> getConnectionProviderModelParsers()

Returns:

a list with a ConnectionProviderModelParser per each connection provider defined in the extension.

getFunctionModelParsers

List<FunctionModelParser> getFunctionModelParsers()

Returns:

a list with a FunctionModelParser per each expression function defined in the extension.

getErrorModelParsers

List<ErrorModelParser> getErrorModelParsers()

Returns:

a list with an ErrorModelParser per each error type defined in the extension.

getLicenseModelProperty

LicenseModelProperty getLicenseModelProperty()

Returns:

a LicenseModelProperty which describes the extension's licensing.

getExternalLibraryModels

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

Returns:

a list with an ExternalLibraryModel per each external library defined at the extension level.

getExtensionHandlerModelProperty

Optional<ExceptionHandlerModelProperty> getExtensionHandlerModelProperty()

Returns:

an Optional ExceptionHandlerModelProperty is an exception handler was defined at the extension level.

getDeprecationModel

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

Returns:

the extension's DeprecationModel if one was defined

getXmlDslConfiguration

Optional<XmlDslConfiguration> getXmlDslConfiguration()

Returns:

the extension's XmlDslModel

getExportedTypes

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

Returns:

the list of types that the extension exports

getExportedResources

List<String> getExportedResources()

Returns:

List of resource paths which the extension's exports

getImportedTypes

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

Returns:

the list of types that the extension imports from others

getPrivilegedExportedArtifacts

List<String> getPrivilegedExportedArtifacts()

Returns:

List of artifacts which can access the extension's privileged API

getPrivilegedExportedPackages

List<String> getPrivilegedExportedPackages()

Returns:

List of package names which conform the extension's privileged API.

getSubTypes

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

The extension's subtype mappings.

Returns:

a Map wihich keys represent the base types and each value represents the list of known subtypes

getNotificationModels

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

Returns:

the notifications the extension emits.

getNamespace

String getNamespace()

Returns:

the extension's namespace.

getSinceMuleVersionModelProperty

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

Returns:

an Optional<SinceMuleVersionModelProperty> if it was defined