org.mule.runtime.api.meta.model

Interface ExtensionModel

All Superinterfaces:

DescribedObject, EnrichableModel, HasConnectionProviderModels, HasConstructModels, HasDisplayModel, HasExternalLibraries, HasFunctionModels, HasOperationModels, HasSourceModels, NamedObject

public interface ExtensionModel
extends NamedObject, DescribedObject, EnrichableModel, HasOperationModels, HasSourceModels, HasFunctionModels, HasConnectionProviderModels, HasDisplayModel, HasExternalLibraries, HasConstructModels

An Extension that provides packaged functionality.

Extensions can augment a system by providing new features in the form of operations and connection providers. What makes the extension model different from a class implementing a certain interface is the fact that extensions provide enough information at runtime so that they can be used without prior knowledge, and can be both executed or integrated into tooling seamlessly.

An extension model is not a miscellaneous group of methods, but can be seen (and may be derived from) an object model. As such, an extension will provide several ways to configure itself and will provide a set of operations that may be eventually executed.

The extension model doesn't just map a JVM object model. Extensions provide richer metadata, and a dynamic execution model, but more importantly they restrict the way operations are defined and used to a manageable subset that would deterministic data flow analysis.

An extension doesn't define any predefined syntax, evaluation order or execution paradigm. The operations provided are expected to be used as individual building blocks in a bigger system, hence the name Extension

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Category	getCategory() Returns the extension's Category that identifies the extension.
Optional<ConfigurationModel>	getConfigurationModel(String name) Returns the ConfigurationModel that matches the given name.
List<ConfigurationModel>	getConfigurationModels() Returns the configurationModels available for this extension.
List<ConnectionProviderModel>	getConnectionProviders() Returns the ConnectionProviderModels which will be available to every ConfigurationModel defined in this extension.
Set<ErrorModel>	getErrorModels()
Set<ImportedTypeModel>	getImportedTypes()
MuleVersion	getMinMuleVersion() Returns the extension's Min MuleVersion.
String	getName() A simple name for this extension.
List<OperationModel>	getOperationModels() Returns a List of OperationModels defined at the extension level.
Set<String>	getPrivilegedArtifacts()
Set<String>	getPrivilegedPackages()
Set<String>	getResources()
List<SourceModel>	getSourceModels() Returns a List of SourceModels defined at the extension level.
Set<SubTypesModel>	getSubTypes()
Set<org.mule.metadata.api.model.ObjectType>	getTypes()
String	getVendor() Returns the name of the extension's vendor This name is used to: Represent the extension's vendor Differentiate different extensions with the same name, to give the possibility of having two connectors with the same name, for example, one made by MuleSoft and the second one by a third party
String	getVersion() Returns this extension's version.
XmlDslModel	getXmlDslModel()

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.operation.HasOperationModels

getOperationModel

Methods inherited from interface org.mule.runtime.api.meta.model.source.HasSourceModels

getSourceModel

Methods inherited from interface org.mule.runtime.api.meta.model.function.HasFunctionModels

getFunctionModel, getFunctionModels

Methods inherited from interface org.mule.runtime.api.meta.model.connection.HasConnectionProviderModels

getConnectionProviderModel

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.HasExternalLibraries

getExternalLibraryModels

Methods inherited from interface org.mule.runtime.api.meta.model.construct.HasConstructModels

getConstructModel, getConstructModels

Method Detail

getName

String getName()

A simple name for this extension. Usually one or two simple words that describes the functionality. For example, for an extension that performs validations it could be something like "validation". For an FTP connector it could be "ftp". For a connector that accesses the google contacts API it could be "google-contacts".

To follow the convention described above is important since the name has to be unique. The platform will use this name to make resources available based on it. This attribute will be used in a convention over configuration pattern. It cannot contain spaces

Specified by:

getName in interface NamedObject

Returns:

the name of the object

getVersion

String getVersion()

Returns this extension's version.

The extension version is specified as a Semantic Versioning.

Note that while an extension implements a specific version, nothing prevents several versions of the same extension to coexists at runtime.

Returns:

the version associated with this extension

getConfigurationModels

List<ConfigurationModel> getConfigurationModels()

Returns the configurationModels available for this extension. Each configuration is guaranteed to have a unique name.

The first configuration is the preferred (default) one, the rest of the configurations are ordered alphabetically. If the ExtensionModel contains any OperationModel, then at least one ConfigurationModel is required. However, the existence of one or more ConfigurationModel doesn't require the presence of any OperationModel.

Returns:

an immutable List with the available configurationModels.

getConfigurationModel

Optional<ConfigurationModel> getConfigurationModel(String name)

Returns the ConfigurationModel that matches the given name.

Parameters:

name - case sensitive configuration name

Returns:

an Optional ConfigurationModel

getOperationModels

List<OperationModel> getOperationModels()

Returns a List of OperationModels defined at the extension level.

When an operation is defined at this level, it means that such operation does not require nor accept a configuration.

Each operation is guaranteed to have a unique name which will not overlap with any SourceModel or ConnectionProviderModel defined at any level.

Specified by:

getOperationModels in interface HasOperationModels

Returns:

an immutable List of OperationModel

getConnectionProviders

List<ConnectionProviderModel> getConnectionProviders()

Returns the ConnectionProviderModels which will be available to every ConfigurationModel defined in this extension.

It is valid to define an ExtensionModel which does nothing but exposing connection providers. It is not required for the extension to also expose any ConfigurationModel or OperationModel.

Specified by:

getConnectionProviders in interface HasConnectionProviderModels

Returns:

an immutable List of ConnectionProviderModel

getSourceModels

List<SourceModel> getSourceModels()

Returns a List of SourceModels defined at the extension level. When a source is defined at this level, it means that such source does not require nor accept a configuration.

Each source is guaranteed to have a unique name which will not overlap with any OperationModel or ConnectionProviderModel defined at any level.

Specified by:

getSourceModels in interface HasSourceModels

Returns:

an immutable List of SourceModel

getTypes

Set<org.mule.metadata.api.model.ObjectType> getTypes()

Returns:

an immutable Set with all the object types defined by this extension

getResources

Set<String> getResources()

Returns:

an immutable Set with the paths to all the resources exposed by this extension

getPrivilegedPackages

Set<String> getPrivilegedPackages()

Returns:

an immutable Set with all the Java packages that should be exported as privileged API by this extension

getPrivilegedArtifacts

Set<String> getPrivilegedArtifacts()

Returns:

an immutable Set with all the artifact IDs that have access to the privileged API exported by this extension. Each artifact is defined using Maven's groupId:artifactId

getVendor

String getVendor()

Returns the name of the extension's vendor This name is used to:

• Represent the extension's vendor
• Differentiate different extensions with the same name, to give the possibility of having two connectors with the same name, for example, one made by MuleSoft and the second one by a third party

Returns:

the name of the extension's vendor

getCategory

Category getCategory()

Returns the extension's Category that identifies the extension.

Returns:

the extension's Category

See Also:

Category

getXmlDslModel

XmlDslModel getXmlDslModel()

Returns:

the XmlDslModel which describes the language which allows using the extension

getSubTypes

Set<SubTypesModel> getSubTypes()

Returns:

A Set of SubTypesModel which describes the subtypes defined by this extension

getImportedTypes

Set<ImportedTypeModel> getImportedTypes()

Returns:

A Set of ImportedTypeModel which describes the types that are imported by this extension

getMinMuleVersion

MuleVersion getMinMuleVersion()

Returns the extension's Min MuleVersion. This MuleVersion represents the minimum version of the Mule Runtime that the extension requires to work correctly.

Returns:

the extension's Min MuleVersion.

getErrorModels

Set<ErrorModel> getErrorModels()

Returns:

A Set of ErrorModel registered in the extension.