Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.internal.loader

Class DefaultExtensionLoadingContext

java.lang.Object

org.mule.runtime.extension.internal.loader.DefaultExtensionLoadingContext

All Implemented Interfaces:

ExtensionLoadingContext

public final class DefaultExtensionLoadingContext
extends Object
implements ExtensionLoadingContext

Default implementation of ExtensionLoadingContext. The fact that this class's attributes are immutable, doesn't mean that their inner state is in fact immutable also.

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.extension.api.loader.ExtensionLoadingContext

EXTENSION_LOADER_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultExtensionLoadingContext(ClassLoader extensionClassLoader, org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext)
DefaultExtensionLoadingContext(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer declarer, ClassLoader extensionClassLoader, org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext)
DefaultExtensionLoadingContext(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer extensionDeclarer, ExtensionModelLoadingRequest request)
DefaultExtensionLoadingContext(ExtensionModelLoadingRequest request)

Method Summary

Modifier and Type	Method	Description
ExtensionLoadingContext	addCustomDeclarationEnricher(DeclarationEnricher enricher)	Registers a custom DeclarationEnricher which is executed before the ones that the runtime automatically applies.
ExtensionLoadingContext	addCustomDeclarationEnrichers(Collection<DeclarationEnricher> enrichers)	Registers custom DeclarationEnricher which are executed before the ones that the runtime automatically applies.
ExtensionLoadingContext	addCustomValidator(ExtensionModelValidator extensionModelValidator)	Registers a custom ExtensionModelValidator to be executed on top of the ones which the runtime applies by default.
ExtensionLoadingContext	addCustomValidators(Collection<ExtensionModelValidator> extensionModelValidators)	Registers custom ExtensionModelValidator to be executed on top of the ones which the runtime applies by default.
void	addParameter(String key, Object value)	Adds a custom parameter registered under key
void	addParameters(Map<String,Object> parameters)	Adds the contents of the given map as custom parameters
Optional<org.mule.runtime.api.artifact.ArtifactCoordinates>	getArtifactCoordinates()
List<DeclarationEnricher>	getCustomDeclarationEnrichers()
List<ExtensionModelValidator>	getCustomValidators()
org.mule.runtime.api.dsl.DslResolvingContext	getDslResolvingContext()
ClassLoader	getExtensionClassLoader()
org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer	getExtensionDeclarer()	The ExtensionDeclarer in which the extension is being described into
<T> Optional<T>	getParameter(String key)	Obtains the custom parameter registered under key.
org.mule.metadata.api.ClassTypeLoader	getTypeLoader()
boolean	isForceExtensionValidation()
boolean	isOCSEnabled()
boolean	isResolveMinMuleVersion()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultExtensionLoadingContext

public DefaultExtensionLoadingContext(ClassLoader extensionClassLoader,
 org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext)

DefaultExtensionLoadingContext

public DefaultExtensionLoadingContext(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer declarer,
 ClassLoader extensionClassLoader,
 org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext)

DefaultExtensionLoadingContext

public DefaultExtensionLoadingContext(ExtensionModelLoadingRequest request)

DefaultExtensionLoadingContext

public DefaultExtensionLoadingContext(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer extensionDeclarer,
 ExtensionModelLoadingRequest request)

Method Details

getExtensionDeclarer

public org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer getExtensionDeclarer()

The ExtensionDeclarer in which the extension is being described into

Specified by:

getExtensionDeclarer in interface ExtensionLoadingContext

Returns:

a non null ExtensionDeclarer

getTypeLoader

public org.mule.metadata.api.ClassTypeLoader getTypeLoader()

Specified by:

getTypeLoader in interface ExtensionLoadingContext

Returns:

a type loader for the types from Java classes within an extension.

addParameter

public void addParameter(String key,
 Object value)

Adds a custom parameter registered under key

Specified by:

addParameter in interface ExtensionLoadingContext

Parameters:

key - the key under which the value is to be registered

value - the custom parameter value

addParameters

public void addParameters(Map<String,Object> parameters)

Description copied from interface: ExtensionLoadingContext

Adds the contents of the given map as custom parameters

Specified by:

addParameters in interface ExtensionLoadingContext

Parameters:

parameters - a map with custom parameters

getParameter

public <T> Optional<T> getParameter(String key)

Obtains the custom parameter registered under key.

Specified by:

getParameter in interface ExtensionLoadingContext

Type Parameters:

T - generic type of the expected value

Parameters:

key - the key under which the wanted value is registered

Returns:

an Optional value

addCustomValidator

public ExtensionLoadingContext addCustomValidator(ExtensionModelValidator extensionModelValidator)

Registers a custom ExtensionModelValidator to be executed on top of the ones which the runtime applies by default.

Custom validators will not apply globally but just for the model being loaded with this context.

Specified by:

addCustomValidator in interface ExtensionLoadingContext

Parameters:

extensionModelValidator - the custom validator

Returns:

this instance

addCustomValidators

public ExtensionLoadingContext addCustomValidators(Collection<ExtensionModelValidator> extensionModelValidators)

Registers custom ExtensionModelValidator to be executed on top of the ones which the runtime applies by default.

These custom validators will not apply globaly but just for the model being loaded with this context.

Specified by:

addCustomValidators in interface ExtensionLoadingContext

Parameters:

extensionModelValidators - the custom validators

Returns:

this instance

addCustomDeclarationEnricher

public ExtensionLoadingContext addCustomDeclarationEnricher(DeclarationEnricher enricher)

Registers a custom DeclarationEnricher which is executed before the ones that the runtime automatically applies.

Specified by:

addCustomDeclarationEnricher in interface ExtensionLoadingContext

Parameters:

enricher - the custom enricher

Returns:

this instance

addCustomDeclarationEnrichers

public ExtensionLoadingContext addCustomDeclarationEnrichers(Collection<DeclarationEnricher> enrichers)

Registers custom DeclarationEnricher which are executed before the ones that the runtime automatically applies.

Specified by:

addCustomDeclarationEnrichers in interface ExtensionLoadingContext

Parameters:

enrichers - the custom enrichers

Returns:

this instance

getExtensionClassLoader

public ClassLoader getExtensionClassLoader()

Specified by:

getExtensionClassLoader in interface ExtensionLoadingContext

Returns:

the extension's ClassLoader

getDslResolvingContext

public org.mule.runtime.api.dsl.DslResolvingContext getDslResolvingContext()

Specified by:

getDslResolvingContext in interface ExtensionLoadingContext

Returns:

the DslResolvingContext with all the dependencies to load an ExtensionModel

isOCSEnabled

public boolean isOCSEnabled()

Specified by:

isOCSEnabled in interface ExtensionLoadingContext

Returns:

whether OCS is enabled

isForceExtensionValidation

public boolean isForceExtensionValidation()

Specified by:

isForceExtensionValidation in interface ExtensionLoadingContext

Returns:

whether the extension must be validated after being loaded.

isResolveMinMuleVersion

public boolean isResolveMinMuleVersion()

Specified by:

isResolveMinMuleVersion in interface ExtensionLoadingContext

Returns:

whether the minMuleVersion of each component must be calculated.

getArtifactCoordinates

public Optional<org.mule.runtime.api.artifact.ArtifactCoordinates> getArtifactCoordinates()

Specified by:

getArtifactCoordinates in interface ExtensionLoadingContext

Returns:

the ArtifactCoordinates of the Extension

getCustomDeclarationEnrichers

public List<DeclarationEnricher> getCustomDeclarationEnrichers()

Specified by:

getCustomDeclarationEnrichers in interface ExtensionLoadingContext

Returns:

an immutable list with the registered custom enrichers

getCustomValidators

public List<ExtensionModelValidator> getCustomValidators()

Specified by:

getCustomValidators in interface ExtensionLoadingContext

Returns:

an immutable list with the registered custom validators