org.mule.runtime.extension.api.introspection

Class ImmutableExtensionModel

java.lang.Object

org.mule.runtime.extension.api.introspection.AbstractImmutableModel

org.mule.runtime.extension.api.introspection.AbstractNamedImmutableModel

org.mule.runtime.extension.api.introspection.AbstractComplexModel

org.mule.runtime.extension.api.introspection.ImmutableExtensionModel

All Implemented Interfaces:

HasConnectionProviderModels, Described, EnrichableModel, ExtensionModel, Named, HasOperationModels, HasSourceModels

Direct Known Subclasses:

ImmutableRuntimeExtensionModel

public class ImmutableExtensionModel
extends AbstractComplexModel
implements ExtensionModel

Immutable implementation of ExtensionModel

Since:

1.0

Constructor Summary

Constructors

Constructor and Description

ImmutableExtensionModel(String name, String description, String version, String vendor, Category category, org.mule.runtime.api.MuleVersion minMuleVersion, List<ConfigurationModel> configurationModels, List<OperationModel> operationModels, List<ConnectionProviderModel> connectionProviders, List<SourceModel> sourceModels, Set<org.mule.metadata.api.model.ObjectType> types, Set<ModelProperty> modelProperties) Creates a new instance with the given state

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.
org.mule.runtime.api.MuleVersion	getMinMuleVersion() Returns the extension's Min MuleVersion.
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.

Methods inherited from class org.mule.runtime.extension.api.introspection.AbstractComplexModel

findModel, getConnectionProviderModel, getConnectionProviders, getOperationModel, getOperationModels, getSourceModel, getSourceModels, toList, unique

Methods inherited from class org.mule.runtime.extension.api.introspection.AbstractNamedImmutableModel

checkArgument, equals, getName, hashCode, toString

Methods inherited from class org.mule.runtime.extension.api.introspection.AbstractImmutableModel

getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.extension.api.introspection.ExtensionModel

getConnectionProviders, getName, getOperationModels, getSourceModels

Methods inherited from interface org.mule.runtime.extension.api.introspection.Described

getDescription

Methods inherited from interface org.mule.runtime.extension.api.introspection.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.extension.api.introspection.operation.HasOperationModels

getOperationModel

Methods inherited from interface org.mule.runtime.extension.api.introspection.source.HasSourceModels

getSourceModel

Methods inherited from interface org.mule.runtime.extension.api.introspection.connection.HasConnectionProviderModels

getConnectionProviderModel

Constructor Detail

ImmutableExtensionModel

public ImmutableExtensionModel(String name,
                               String description,
                               String version,
                               String vendor,
                               Category category,
                               org.mule.runtime.api.MuleVersion minMuleVersion,
                               List<ConfigurationModel> configurationModels,
                               List<OperationModel> operationModels,
                               List<ConnectionProviderModel> connectionProviders,
                               List<SourceModel> sourceModels,
                               Set<org.mule.metadata.api.model.ObjectType> types,
                               Set<ModelProperty> modelProperties)

Creates a new instance with the given state

Parameters:

name - the extension's name. Cannot be blank

description - the extension's description

version - the extension's version

vendor - the extension's vendor name

category - the extension's Category

minMuleVersion - the extension's minimum MuleVersion

configurationModels - a List with the extension's configurationModels

operationModels - a List with the extension's operationModels

connectionProviders - a List with the extension's connection provider models

sourceModels - a List with the extension's message source models

types - a Set with the custom types defined by this extension

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if configurations or ParameterModel are null or contain instances with non unique names, or if name is blank

Method Detail

getConfigurationModels

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

Specified by:

getConfigurationModels in interface ExtensionModel

Returns:

an immutable List with the available configurationModels.

getConfigurationModel

public Optional<ConfigurationModel> getConfigurationModel(String name)

Returns the ConfigurationModel that matches the given name.

Specified by:

getConfigurationModel in interface ExtensionModel

Parameters:

name - case sensitive configuration name

Returns:

an Optional ConfigurationModel

getVersion

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

Specified by:

getVersion in interface ExtensionModel

Returns:

the version associated with this extension

getVendor

public 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

Specified by:

getVendor in interface ExtensionModel

Returns:

the name of the extension's vendor

getCategory

public Category getCategory()

Returns the extension's Category that identifies the extension.

Specified by:

getCategory in interface ExtensionModel

Returns:

the extension's Category

See Also:

Category

getMinMuleVersion

public org.mule.runtime.api.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.

Specified by:

getMinMuleVersion in interface ExtensionModel

Returns:

the extension's Min MuleVersion.

getTypes

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

Specified by:

getTypes in interface ExtensionModel

Returns:

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