org.mule.runtime.extension.api.model

Class ImmutableExtensionModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

org.mule.runtime.extension.api.model.AbstractComplexModel

org.mule.runtime.extension.api.model.ImmutableExtensionModel

All Implemented Interfaces:

org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.connection.HasConnectionProviderModels, org.mule.runtime.api.meta.model.construct.HasConstructModels, org.mule.runtime.api.meta.model.deprecated.DeprecableModel, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.ExtensionModel, org.mule.runtime.api.meta.model.function.HasFunctionModels, org.mule.runtime.api.meta.model.HasExternalLibraries, org.mule.runtime.api.meta.model.operation.HasOperationModels, org.mule.runtime.api.meta.model.source.HasSourceModels, org.mule.runtime.api.meta.NamedObject

public class ImmutableExtensionModel
extends AbstractComplexModel
implements org.mule.runtime.api.meta.model.ExtensionModel, org.mule.runtime.api.meta.model.function.HasFunctionModels

Immutable implementation of ExtensionModel

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Constructor and Description
ImmutableExtensionModel(String name, String description, String version, String vendor, org.mule.runtime.api.meta.Category category, List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels, List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels, List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders, List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels, List<org.mule.runtime.api.meta.model.function.FunctionModel> functions, List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel, Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes, Set<org.mule.metadata.api.model.ObjectType> types, Set<String> resources, Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels, Set<String> privilegedPackages, Set<String> privilegedArtifacts, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Deprecated. This constructor is deprecated and will be removed in Mule 5. Use ImmutableExtensionModel(String, String, String, String, Category, List, List, List, List, List, List, DisplayModel, XmlDslModel, Set, Set, Set, Set, Set, Set, Set, Set, Set, Set) instead
ImmutableExtensionModel(String name, String description, String version, String vendor, org.mule.runtime.api.meta.Category category, List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels, List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels, List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders, List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels, List<org.mule.runtime.api.meta.model.function.FunctionModel> functions, List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel, Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes, Set<org.mule.metadata.api.model.ObjectType> types, Set<String> resources, Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels, Set<String> privilegedPackages, Set<String> privilegedArtifacts, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications) Creates a new instance with the given state
ImmutableExtensionModel(String name, String description, String version, String vendor, org.mule.runtime.api.meta.Category category, List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels, List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels, List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders, List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels, List<org.mule.runtime.api.meta.model.function.FunctionModel> functions, List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel, Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes, Set<org.mule.metadata.api.model.ObjectType> types, Set<String> resources, Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels, Set<String> privilegedPackages, Set<String> privilegedArtifacts, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.meta.Category	getCategory()
Optional<org.mule.runtime.api.meta.model.config.ConfigurationModel>	getConfigurationModel(String name)
List<org.mule.runtime.api.meta.model.config.ConfigurationModel>	getConfigurationModels()
Optional<org.mule.runtime.api.meta.model.construct.ConstructModel>	getConstructModel(String name)
List<org.mule.runtime.api.meta.model.construct.ConstructModel>	getConstructModels()
Set<org.mule.runtime.api.meta.model.error.ErrorModel>	getErrorModels()
Set<org.mule.runtime.api.meta.model.ExternalLibraryModel>	getExternalLibraryModels()
Optional<org.mule.runtime.api.meta.model.function.FunctionModel>	getFunctionModel(String name)
List<org.mule.runtime.api.meta.model.function.FunctionModel>	getFunctionModels()
Set<org.mule.runtime.api.meta.model.ImportedTypeModel>	getImportedTypes()
Set<org.mule.runtime.api.meta.model.notification.NotificationModel>	getNotificationModels()
Set<String>	getPrivilegedArtifacts()
Set<String>	getPrivilegedPackages()
Set<String>	getResources()
Set<org.mule.runtime.api.meta.model.SubTypesModel>	getSubTypes()
Set<org.mule.metadata.api.model.ObjectType>	getTypes()
String	getVendor()
String	getVersion()
org.mule.runtime.api.meta.model.XmlDslModel	getXmlDslModel()

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

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

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

checkArgument, equals, getDisplayModel, getName, hashCode, toString

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

copy, copy, 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.api.meta.model.ExtensionModel

getConnectionProviders, getName, getOperationModels, getSourceModels

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.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.deprecated.DeprecableModel

getDeprecationModel, isDeprecated

Constructor Detail

ImmutableExtensionModel

@Deprecated
public ImmutableExtensionModel(String name,
                                           String description,
                                           String version,
                                           String vendor,
                                           org.mule.runtime.api.meta.Category category,
                                           List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels,
                                           List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels,
                                           List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders,
                                           List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels,
                                           List<org.mule.runtime.api.meta.model.function.FunctionModel> functions,
                                           List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels,
                                           org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                           org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel,
                                           Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes,
                                           Set<org.mule.metadata.api.model.ObjectType> types,
                                           Set<String> resources,
                                           Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes,
                                           Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                           Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels,
                                           Set<String> privilegedPackages,
                                           Set<String> privilegedArtifacts,
                                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Deprecated. This constructor is deprecated and will be removed in Mule 5. Use ImmutableExtensionModel(String, String, String, String, Category, List, List, List, List, List, List, DisplayModel, XmlDslModel, Set, Set, Set, Set, Set, Set, Set, Set, Set, Set) instead

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

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

functions - A List with the extension's function models

displayModel - A model which contains directive about how the extension is displayed in the UI

xmlDslModel - The XmlDslModel which describes the XML language

subTypes - A Set with the sub types defined by this extension

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

resources - A Set with the paths to all the resources exposed by this extension

importedTypes - A Set of ImportedTypeModel which describes the types that are imported from other extensions

errors - A Set of ErrorModel which communicates the errors that the current extension handles

externalLibraryModels - a Set with the extension's external libraries

privilegedPackages - a Set of Java package names to export on the extension's privileged API.

privilegedArtifacts - a Set of artifact ID that have access to the extension's privileged API.

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.

ImmutableExtensionModel

public ImmutableExtensionModel(String name,
                               String description,
                               String version,
                               String vendor,
                               org.mule.runtime.api.meta.Category category,
                               List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels,
                               List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels,
                               List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders,
                               List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels,
                               List<org.mule.runtime.api.meta.model.function.FunctionModel> functions,
                               List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels,
                               org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                               org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel,
                               Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes,
                               Set<org.mule.metadata.api.model.ObjectType> types,
                               Set<String> resources,
                               Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes,
                               Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                               Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels,
                               Set<String> privilegedPackages,
                               Set<String> privilegedArtifacts,
                               Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                               Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications)

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

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

functions - A List with the extension's function models

displayModel - A model which contains directive about how the extension is displayed in the UI

xmlDslModel - The XmlDslModel which describes the XML language

subTypes - A Set with the sub types defined by this extension

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

resources - A Set with the paths to all the resources exposed by this extension

importedTypes - A Set of ImportedTypeModel which describes the types that are imported from other extensions

errors - A Set of ErrorModel which communicates the errors that the current extension handles

externalLibraryModels - a Set with the extension's external libraries

privilegedPackages - a Set of Java package names to export on the extension's privileged API.

privilegedArtifacts - a Set of artifact ID that have access to the extension's privileged API.

modelProperties - A Set of custom properties which extend this model

notifications - A Set of NotificationModel which describes the extension's notifications

Throws:

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

ImmutableExtensionModel

public ImmutableExtensionModel(String name,
                               String description,
                               String version,
                               String vendor,
                               org.mule.runtime.api.meta.Category category,
                               List<org.mule.runtime.api.meta.model.config.ConfigurationModel> configurationModels,
                               List<org.mule.runtime.api.meta.model.operation.OperationModel> operationModels,
                               List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> connectionProviders,
                               List<org.mule.runtime.api.meta.model.source.SourceModel> sourceModels,
                               List<org.mule.runtime.api.meta.model.function.FunctionModel> functions,
                               List<org.mule.runtime.api.meta.model.construct.ConstructModel> constructModels,
                               org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                               org.mule.runtime.api.meta.model.XmlDslModel xmlDslModel,
                               Set<org.mule.runtime.api.meta.model.SubTypesModel> subTypes,
                               Set<org.mule.metadata.api.model.ObjectType> types,
                               Set<String> resources,
                               Set<org.mule.runtime.api.meta.model.ImportedTypeModel> importedTypes,
                               Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                               Set<org.mule.runtime.api.meta.model.ExternalLibraryModel> externalLibraryModels,
                               Set<String> privilegedPackages,
                               Set<String> privilegedArtifacts,
                               Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                               Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications,
                               org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)

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

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

functions - A List with the extension's function models

displayModel - A model which contains directive about how the extension is displayed in the UI

xmlDslModel - The XmlDslModel which describes the XML language

subTypes - A Set with the sub types defined by this extension

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

resources - A Set with the paths to all the resources exposed by this extension

importedTypes - A Set of ImportedTypeModel which describes the types that are imported from other extensions

errors - A Set of ErrorModel which communicates the errors that the current extension handles

externalLibraryModels - a Set with the extension's external libraries

privilegedPackages - a Set of Java package names to export on the extension's privileged API.

privilegedArtifacts - a Set of artifact ID that have access to the extension's privileged API.

modelProperties - A Set of custom properties which extend this model

notifications - A Set of NotificationModel which describes the extension's notifications

deprecationModel - a DeprecationModel describing if the extension is deprecated. A null value means it is not deprecated.

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<org.mule.runtime.api.meta.model.config.ConfigurationModel> getConfigurationModels()

Specified by:

getConfigurationModels in interface org.mule.runtime.api.meta.model.ExtensionModel

getConfigurationModel

public Optional<org.mule.runtime.api.meta.model.config.ConfigurationModel> getConfigurationModel(String name)

Specified by:

getConfigurationModel in interface org.mule.runtime.api.meta.model.ExtensionModel

getConstructModels

public List<org.mule.runtime.api.meta.model.construct.ConstructModel> getConstructModels()

Specified by:

getConstructModels in interface org.mule.runtime.api.meta.model.construct.HasConstructModels

getConstructModel

public Optional<org.mule.runtime.api.meta.model.construct.ConstructModel> getConstructModel(String name)

Specified by:

getConstructModel in interface org.mule.runtime.api.meta.model.construct.HasConstructModels

getFunctionModels

public List<org.mule.runtime.api.meta.model.function.FunctionModel> getFunctionModels()

Specified by:

getFunctionModels in interface org.mule.runtime.api.meta.model.function.HasFunctionModels

getFunctionModel

public Optional<org.mule.runtime.api.meta.model.function.FunctionModel> getFunctionModel(String name)

Specified by:

getFunctionModel in interface org.mule.runtime.api.meta.model.function.HasFunctionModels

getVersion

public String getVersion()

Specified by:

getVersion in interface org.mule.runtime.api.meta.model.ExtensionModel

getVendor

public String getVendor()

Specified by:

getVendor in interface org.mule.runtime.api.meta.model.ExtensionModel

getCategory

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

Specified by:

getCategory in interface org.mule.runtime.api.meta.model.ExtensionModel

getTypes

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

Specified by:

getTypes in interface org.mule.runtime.api.meta.model.ExtensionModel

getPrivilegedPackages

public Set<String> getPrivilegedPackages()

Specified by:

getPrivilegedPackages in interface org.mule.runtime.api.meta.model.ExtensionModel

getPrivilegedArtifacts

public Set<String> getPrivilegedArtifacts()

Specified by:

getPrivilegedArtifacts in interface org.mule.runtime.api.meta.model.ExtensionModel

getResources

public Set<String> getResources()

Specified by:

getResources in interface org.mule.runtime.api.meta.model.ExtensionModel

getImportedTypes

public Set<org.mule.runtime.api.meta.model.ImportedTypeModel> getImportedTypes()

Specified by:

getImportedTypes in interface org.mule.runtime.api.meta.model.ExtensionModel

getXmlDslModel

public org.mule.runtime.api.meta.model.XmlDslModel getXmlDslModel()

Specified by:

getXmlDslModel in interface org.mule.runtime.api.meta.model.ExtensionModel

getSubTypes

public Set<org.mule.runtime.api.meta.model.SubTypesModel> getSubTypes()

Specified by:

getSubTypes in interface org.mule.runtime.api.meta.model.ExtensionModel

getErrorModels

public Set<org.mule.runtime.api.meta.model.error.ErrorModel> getErrorModels()

Specified by:

getErrorModels in interface org.mule.runtime.api.meta.model.ExtensionModel

getNotificationModels

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

Specified by:

getNotificationModels in interface org.mule.runtime.api.meta.model.ExtensionModel

getExternalLibraryModels

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

Specified by:

getExternalLibraryModels in interface org.mule.runtime.api.meta.model.HasExternalLibraries