org.mule.runtime.api.meta.model.declaration.fluent

Class ExtensionDeclaration

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.NamedDeclaration<ExtensionDeclaration>

org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration

All Implemented Interfaces:

DescribedObject, ConnectedDeclaration<ExtensionDeclaration>, WithConstructsDeclaration<ExtensionDeclaration>, WithDeprecatedDeclaration, WithFunctionsDeclaration<ExtensionDeclaration>, WithOperationsDeclaration<ExtensionDeclaration>, WithSourcesDeclaration<ExtensionDeclaration>, NamedObject

public class ExtensionDeclaration
extends NamedDeclaration<ExtensionDeclaration>
implements ConnectedDeclaration<ExtensionDeclaration>, WithSourcesDeclaration<ExtensionDeclaration>, WithOperationsDeclaration<ExtensionDeclaration>, WithFunctionsDeclaration<ExtensionDeclaration>, WithConstructsDeclaration<ExtensionDeclaration>, WithDeprecatedDeclaration

A declaration object for a ExtensionModel. It contains raw, unvalidated data which is used to declare the structure of a ExtensionModel

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ExtensionDeclaration	addConfig(ConfigurationDeclaration config) Adds a ConfigurationDeclaration
ExtensionDeclaration	addConnectionProvider(ConnectionProviderDeclaration connectionProvider) Adds a ConnectionProviderDeclaration
ExtensionDeclaration	addConstruct(ConstructDeclaration declaration) Adds a ConstructDeclaration
void	addErrorModel(ErrorModel errorModel)
ExtensionDeclaration	addExternalLibrary(ExternalLibraryModel externalLibraryModel) Adds an ExternalLibraryModel
ExtensionDeclaration	addFunction(FunctionDeclaration function) Adds a FunctionDeclaration
ExtensionDeclaration	addImportedType(ImportedTypeModel importedType) Declares that the extension is importing a type from another extension
ExtensionDeclaration	addMessageSource(SourceDeclaration sourceDeclaration) Adds a SourceDeclaration
void	addNotificationModel(NotificationModel notificationModel)
ExtensionDeclaration	addOperation(OperationDeclaration operation) Adds a OperationDeclaration
ExtensionDeclaration	addPrivilegedArtifact(String artifactId) Declares that this extension declares a privileged API accessible by a given artifact
ExtensionDeclaration	addPrivilegedPackage(String packageName) Declares that this extension declares a privileged API exporting a Java package
ExtensionDeclaration	addResource(String resourcePath) Declares that this extension contains a resource which can be found at the relative resourcePath
void	addSubtype(org.mule.metadata.api.model.MetadataType baseType, org.mule.metadata.api.model.MetadataType subType) Registers the given subType as an implementation of the baseType
void	addSubtypes(org.mule.metadata.api.model.MetadataType baseType, Collection<org.mule.metadata.api.model.MetadataType> subTypes) Registers the given subTypes as implementations of the baseType
ExtensionDeclaration	addType(org.mule.metadata.api.model.ObjectType objectType) Declares that this extension defined the given objectType
Category	getCategory()
List<ConfigurationDeclaration>	getConfigurations() Returns an immutable list with the ConfigurationDeclaration instances that have been declared so far.
List<ConnectionProviderDeclaration>	getConnectionProviders()
List<ConstructDeclaration>	getConstructs()
Optional<DeprecationModel>	getDeprecation()
Set<ErrorModel>	getErrorModels()
Set<ExternalLibraryModel>	getExternalLibraryModels()
List<FunctionDeclaration>	getFunctions()
Set<ImportedTypeModel>	getImportedTypes()
List<SourceDeclaration>	getMessageSources()
String	getName() Gets the name of the object
Set<NotificationModel>	getNotificationModels()
List<OperationDeclaration>	getOperations()
Set<String>	getPrivilegedArtifacts()
Set<String>	getPrivilegedPackages()
Set<String>	getResources()
Set<SubTypesModel>	getSubTypes()
Set<org.mule.metadata.api.model.ObjectType>	getTypes()
String	getVendor()
String	getVersion()
XmlDslModel	getXmlDslModel()
void	setCategory(Category category)
void	setName(String name)
void	setVendor(String vendor)
void	setXmlDslModel(XmlDslModel xmlDslModel)
void	withDeprecation(DeprecationModel deprecation)

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration

addModelProperty, getDescription, getDisplayModel, getModelProperties, getModelProperty, setDescription, setDisplayModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConfigurations

public List<ConfigurationDeclaration> getConfigurations()

Returns an immutable list with the ConfigurationDeclaration instances that have been declared so far.

Returns:

an unmodifiable list. May be empty but will never be null

addConfig

public ExtensionDeclaration addConfig(ConfigurationDeclaration config)

Adds a ConfigurationDeclaration

Parameters:

config - a not null ConfigurationDeclaration

Returns:

this declaration

Throws:

{@link - IllegalArgumentException} if config is null

getConstructs

public List<ConstructDeclaration> getConstructs()

Specified by:

getConstructs in interface WithConstructsDeclaration<ExtensionDeclaration>

Returns:

an unmodifiable List with the available ConstructDeclarations

addConstruct

public ExtensionDeclaration addConstruct(ConstructDeclaration declaration)

Adds a ConstructDeclaration

Specified by:

addConstruct in interface WithConstructsDeclaration<ExtensionDeclaration>

Parameters:

declaration - the declaration to be added

Returns:

this declarer

getOperations

public List<OperationDeclaration> getOperations()

Specified by:

getOperations in interface WithOperationsDeclaration<ExtensionDeclaration>

Returns:

an unmodifiable List with the available OperationDeclarations

getConnectionProviders

public List<ConnectionProviderDeclaration> getConnectionProviders()

Specified by:

getConnectionProviders in interface ConnectedDeclaration<ExtensionDeclaration>

Returns:

an unmodifiable List with the available ConnectionProviderDeclarations

getMessageSources

public List<SourceDeclaration> getMessageSources()

Specified by:

getMessageSources in interface WithSourcesDeclaration<ExtensionDeclaration>

Returns:

an unmodifiable List with the available SourceDeclarations

addConnectionProvider

public ExtensionDeclaration addConnectionProvider(ConnectionProviderDeclaration connectionProvider)

Adds a ConnectionProviderDeclaration

Specified by:

addConnectionProvider in interface ConnectedDeclaration<ExtensionDeclaration>

Parameters:

connectionProvider - a not null ConnectionProviderDeclaration

Returns:

this declaration

Throws:

IllegalArgumentException - if connectionProvider is null

addOperation

public ExtensionDeclaration addOperation(OperationDeclaration operation)

Adds a OperationDeclaration

Specified by:

addOperation in interface WithOperationsDeclaration<ExtensionDeclaration>

Parameters:

operation - a not null OperationDeclaration

Returns:

this declaration

Throws:

{@link - IllegalArgumentException} if operation is null

addMessageSource

public ExtensionDeclaration addMessageSource(SourceDeclaration sourceDeclaration)

Adds a SourceDeclaration

Specified by:

addMessageSource in interface WithSourcesDeclaration<ExtensionDeclaration>

Parameters:

sourceDeclaration - a not null SourceDeclaration

Returns:

this declaration

Throws:

{@link - IllegalArgumentException} if sourceDeclaration is null

addFunction

public ExtensionDeclaration addFunction(FunctionDeclaration function)

Adds a FunctionDeclaration

Specified by:

addFunction in interface WithFunctionsDeclaration<ExtensionDeclaration>

Parameters:

function - the provider's declaration

Returns:

this declaration

getFunctions

public List<FunctionDeclaration> getFunctions()

Specified by:

getFunctions in interface WithFunctionsDeclaration<ExtensionDeclaration>

Returns:

a List with the FunctionDeclaration which have been added to this declaration

getTypes

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

Returns:

an immutable Set with all the types registered through getTypes()

getResources

public Set<String> getResources()

Returns:

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

getPrivilegedPackages

public Set<String> getPrivilegedPackages()

Returns:

an immutable Set with all the Java package name that are registered as privileged API

getPrivilegedArtifacts

public Set<String> getPrivilegedArtifacts()

Returns:

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

addType

public ExtensionDeclaration addType(org.mule.metadata.api.model.ObjectType objectType)

Declares that this extension defined the given objectType

Parameters:

objectType - an ObjectType

Returns:

this declaration

addResource

public ExtensionDeclaration addResource(String resourcePath)

Declares that this extension contains a resource which can be found at the relative resourcePath

Parameters:

resourcePath - the relative path to the extension's resource

Returns:

this declaration

addPrivilegedPackage

public ExtensionDeclaration addPrivilegedPackage(String packageName)

Declares that this extension declares a privileged API exporting a Java package

Parameters:

packageName - the Java package name to be exported

Returns:

this declaration

addPrivilegedArtifact

public ExtensionDeclaration addPrivilegedArtifact(String artifactId)

Declares that this extension declares a privileged API accessible by a given artifact

Parameters:

artifactId - the artifactId that the extension provides access to the privileged API

Returns:

this declaration

addImportedType

public ExtensionDeclaration addImportedType(ImportedTypeModel importedType)

Declares that the extension is importing a type from another extension

Parameters:

importedType - a ImportedTypeModel with the import information

Returns:

this declaration

addExternalLibrary

public ExtensionDeclaration addExternalLibrary(ExternalLibraryModel externalLibraryModel)

Adds an ExternalLibraryModel

Parameters:

externalLibraryModel - the model of the external library to be referenced

Returns:

this declarer

addSubtype

public void addSubtype(org.mule.metadata.api.model.MetadataType baseType,
                       org.mule.metadata.api.model.MetadataType subType)

Registers the given subType as an implementation of the baseType

Parameters:

baseType - a base type

subType - a sub type implementation

addSubtypes

public void addSubtypes(org.mule.metadata.api.model.MetadataType baseType,
                        Collection<org.mule.metadata.api.model.MetadataType> subTypes)

Registers the given subTypes as implementations of the baseType

Parameters:

baseType - a base type

subTypes - a Collection of sub type implementations

getSubTypes

public Set<SubTypesModel> getSubTypes()

Returns:

a Map with the subType mappings declared through addSubtype(MetadataType, MetadataType) and addSubtypes(MetadataType, Collection)

getExternalLibraryModels

public Set<ExternalLibraryModel> getExternalLibraryModels()

Returns:

A Set of ExternalLibraryModel which represent the extension's external libraries

getName

public String getName()

Gets the name of the object

Specified by:

getName in interface NamedObject

Overrides:

getName in class NamedDeclaration<ExtensionDeclaration>

Returns:

the name of the object

setName

public void setName(String name)

getVersion

public String getVersion()

getVendor

public String getVendor()

setVendor

public void setVendor(String vendor)

getCategory

public Category getCategory()

setCategory

public void setCategory(Category category)

getXmlDslModel

public XmlDslModel getXmlDslModel()

setXmlDslModel

public void setXmlDslModel(XmlDslModel xmlDslModel)

getImportedTypes

public Set<ImportedTypeModel> getImportedTypes()

addErrorModel

public void addErrorModel(ErrorModel errorModel)

getErrorModels

public Set<ErrorModel> getErrorModels()

addNotificationModel

public void addNotificationModel(NotificationModel notificationModel)

getNotificationModels

public Set<NotificationModel> getNotificationModels()

getDeprecation

public Optional<DeprecationModel> getDeprecation()

Specified by:

getDeprecation in interface WithDeprecatedDeclaration

Returns:

this components DeprecationModel

withDeprecation

public void withDeprecation(DeprecationModel deprecation)

Specified by:

withDeprecation in interface WithDeprecatedDeclaration

Parameters:

deprecation - this components DeprecationModel