org.mule.runtime.extension.api.introspection.declaration.fluent

Class ExtensionDeclaration

java.lang.Object

org.mule.runtime.extension.api.introspection.declaration.fluent.BaseDeclaration<T>

org.mule.runtime.extension.api.introspection.declaration.fluent.NamedDeclaration<ExtensionDeclaration>

org.mule.runtime.extension.api.introspection.declaration.fluent.ExtensionDeclaration

All Implemented Interfaces:

ConnectedDeclaration<ExtensionDeclaration>, WithOperationsDeclaration<ExtensionDeclaration>, WithSourcesDeclaration<ExtensionDeclaration>, Described, Named

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

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	addMessageSource(SourceDeclaration sourceDeclaration) Adds a SourceDeclaration
ExtensionDeclaration	addOperation(OperationDeclaration operation) Adds a OperationDeclaration
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()
Optional<ExceptionEnricherFactory>	getExceptionEnricherFactory()
List<SourceDeclaration>	getMessageSources()
org.mule.runtime.api.MuleVersion	getMinMuleVersion()
String	getName() Returns the component's name
List<OperationDeclaration>	getOperations()
Set<org.mule.metadata.api.model.ObjectType>	getTypes()
String	getVendor()
String	getVersion()
void	setCategory(Category category)
void	setExceptionEnricherFactory(Optional<ExceptionEnricherFactory> exceptionEnricherFactory)
void	setMinMuleVersion(org.mule.runtime.api.MuleVersion minMuleVersion)
void	setName(String name)
void	setVendor(String vendor)

Methods inherited from class org.mule.runtime.extension.api.introspection.declaration.fluent.BaseDeclaration

addModelProperty, getDescription, getModelProperties, getModelProperty, setDescription

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

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

getTypes

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

Returns:

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

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

getName

public String getName()

Returns the component's name

Specified by:

getName in interface Named

Overrides:

getName in class NamedDeclaration<ExtensionDeclaration>

Returns:

a non blank String

setName

public void setName(String name)

getVersion

public String getVersion()

getVendor

public String getVendor()

setVendor

public void setVendor(String vendor)

getExceptionEnricherFactory

public Optional<ExceptionEnricherFactory> getExceptionEnricherFactory()

setExceptionEnricherFactory

public void setExceptionEnricherFactory(Optional<ExceptionEnricherFactory> exceptionEnricherFactory)

getCategory

public Category getCategory()

setCategory

public void setCategory(Category category)

getMinMuleVersion

public org.mule.runtime.api.MuleVersion getMinMuleVersion()

setMinMuleVersion

public void setMinMuleVersion(org.mule.runtime.api.MuleVersion minMuleVersion)