Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.loader

Class ExtensionModelLoader

java.lang.Object

org.mule.runtime.extension.api.loader.ExtensionModelLoader

@NoImplement
public abstract class ExtensionModelLoader
extends Object

Loader of an ExtensionModel for a Mule plugin artifact from a set of attributes read by the MulePluginModel.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DONT_SET_DEFAULT_VALUE_TO_BOOLEAN_PARAMS	Avoids setting a default value of false to parameters of boolean type.

Constructor Summary

Constructors

Constructor	Description
ExtensionModelLoader()

Method Summary

Modifier and Type	Method	Description
protected void	configureContextBeforeDeclaration(ExtensionLoadingContext context)	Allows adding pre-configured the given context before it's fed into declareExtension(ExtensionLoadingContext).
protected abstract void	declareExtension(ExtensionLoadingContext context)	This method uses the ExtensionDeclarer found through ExtensionLoadingContext.getExtensionDeclarer() to define the ExtensionModel to be loaded.
protected org.mule.runtime.api.meta.model.ExtensionModel	doCreate(ExtensionLoadingContext context)	Creates an ExtensionModel from the context.
abstract String	getId()
final org.mule.runtime.api.meta.model.ExtensionModel	loadExtensionModel(ClassLoader pluginClassLoader, org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext, Map<String,Object> attributes)	Deprecated. since 1.5.0.
final org.mule.runtime.api.meta.model.ExtensionModel	loadExtensionModel(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer extensionDeclarer, ExtensionModelLoadingRequest request)	Creates an ExtensionModel from the request.
final org.mule.runtime.api.meta.model.ExtensionModel	loadExtensionModel(ExtensionModelLoadingRequest request)	Creates an ExtensionModel from the request.

Methods inherited from class java.lang.Object

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

Field Details

DONT_SET_DEFAULT_VALUE_TO_BOOLEAN_PARAMS

public static final String DONT_SET_DEFAULT_VALUE_TO_BOOLEAN_PARAMS

Avoids setting a default value of false to parameters of boolean type.

This is used to avoid W-12003688.

Since:

1.5.0

See Also:

• Constant Field Values

Constructor Details

ExtensionModelLoader

public ExtensionModelLoader()

Method Details

getId

public abstract String getId()

Returns:

an identifier of this ExtensionModelLoader. Non null neither blank.

The ID must be unique among all ExtensionModelLoader.

loadExtensionModel

@Deprecated
public final org.mule.runtime.api.meta.model.ExtensionModel loadExtensionModel(ClassLoader pluginClassLoader,
 org.mule.runtime.api.dsl.DslResolvingContext dslResolvingContext,
 Map<String,Object> attributes)

Deprecated.

since 1.5.0. Use loadExtensionModel(ExtensionModelLoadingRequest) instead

Creates an ExtensionModel from the pluginClassLoader using any attribute it needs from the attributes parameter.

Bear in mind that, is up to each implementation of this method to validate the attributes parameter has the needed elements and that each of them is also of the expected Java class. This is by design, as the invokers of this method knows how to parse descriptor files (see MulePluginModel) for a plugin in a generic way.

This method delegates into declareExtension(ExtensionLoadingContext) in order to obtain the ExtensionDeclaration. That declaration is then transformed into an actual ExtensionModel. While loading the extension, a default set of DeclarationEnricher and ExtensionModelValidator will be applied. The ExtensionLoadingContext received in declareExtension(ExtensionLoadingContext) might additionally contain extra ones. The configureContextBeforeDeclaration(ExtensionLoadingContext) allows to add custom configurations into the context before the declaration begins.

Parameters:

pluginClassLoader - context ClassLoader that holds all the needed classes and resources to properly generate an ExtensionModel.

dslResolvingContext - context with all the ExtensionModels already loaded that are mandatory to execute the method properly.

attributes - a set of attributes to work with in each concrete implementation of ExtensionModelLoader, which will be responsible for extracting the mandatory parameters (while casting, if needed).

Returns:

an ExtensionModel that represents the plugin being described

Throws:

IllegalArgumentException - if there are missing entries in attributes or their type does not match the expected one.

loadExtensionModel

public final org.mule.runtime.api.meta.model.ExtensionModel loadExtensionModel(ExtensionModelLoadingRequest request)

Creates an ExtensionModel from the request.

This method delegates into declareExtension(ExtensionLoadingContext) in order to obtain the ExtensionDeclaration. That declaration is then transformed into an actual ExtensionModel. While loading the extension, a default set of DeclarationEnricher and ExtensionModelValidator will be applied.

The ExtensionLoadingContext received in declareExtension(ExtensionLoadingContext) might additionally contain extra ones. The configureContextBeforeDeclaration(ExtensionLoadingContext) allows to add custom configurations into the context before the declaration begins.

Parameters:

request - a ExtensionModelLoadingRequest which configures the loading operation

Returns:

an ExtensionModel that represents the plugin being described

Throws:

IllegalArgumentException - if there are missing entries in attributes or their type does not match the expected one.

loadExtensionModel

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

Creates an ExtensionModel from the request.

This method delegates into declareExtension(ExtensionLoadingContext) in order to obtain the ExtensionDeclaration. That declaration is then transformed into an actual ExtensionModel. While loading the extension, a default set of DeclarationEnricher and ExtensionModelValidator will be applied.

The ExtensionLoadingContext received in declareExtension(ExtensionLoadingContext) might additionally contain extra ones. The configureContextBeforeDeclaration(ExtensionLoadingContext) allows to add custom configurations into the context before the declaration begins.

Parameters:

extensionDeclarer - a base declarer for the extension to be loaded.

request - a ExtensionModelLoadingRequest which configures the loading operation

Returns:

an ExtensionModel that represents the plugin being described

Throws:

IllegalArgumentException - if there are missing entries in attributes or their type does not match the expected one.

Since:

1.8

doCreate

protected org.mule.runtime.api.meta.model.ExtensionModel doCreate(ExtensionLoadingContext context)

Creates an ExtensionModel from the context.

This method delegates into declareExtension(ExtensionLoadingContext) in order to obtain the ExtensionDeclaration. That declaration is then transformed into an actual ExtensionModel. While loading the extension, a default set of DeclarationEnricher and ExtensionModelValidator will be applied.

Parameters:

context - the context that will be used for the declaration.

Returns:

an ExtensionModel that represents the plugin being described

Throws:

IllegalArgumentException - if there are missing entries in attributes or their type does not match the expected one.

configureContextBeforeDeclaration

protected void configureContextBeforeDeclaration(ExtensionLoadingContext context)

Allows adding pre-configured the given context before it's fed into declareExtension(ExtensionLoadingContext). This is the ideal place to register custom parameters, enrichers, validators, etc.

Parameters:

context - the context that will be used for the declaration

declareExtension

protected abstract void declareExtension(ExtensionLoadingContext context)

This method uses the ExtensionDeclarer found through ExtensionLoadingContext.getExtensionDeclarer() to define the ExtensionModel to be loaded.

IMPORTANT: When this method is executed, the runtime automatically sets the current thread's context classloader to ExtensionLoadingContext.getExtensionClassLoader(). The previous TCCL is restored after this method's execution.

This method should only be invoked by the runtime. Do not invoke manually.

Parameters:

context - the context that will be used for the declaration