org.mule.runtime.extension.api

Interface ExtensionManager

public interface ExtensionManager

Manages the extension models available in the current context and their state.

This class is also the access point to obtaining configuration instances of the extensions in use. For an extension to be usable, it has to be registered in this manager through the registerExtension(ExtensionManifest, ClassLoader) method

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ConfigurationInstance	getConfiguration(ExtensionModel extensionModel, org.mule.runtime.api.message.MuleEvent muleEvent) Returns a ConfigurationInstance for the given extensionModel.
ConfigurationInstance	getConfiguration(String configurationProviderName, org.mule.runtime.api.message.MuleEvent muleEvent) Returns a ConfigurationInstance obtained through a previously registered ConfigurationProvider named as configurationProvider After the ConfigurationProvider has been located, an instance is returned by invoking its ConfigurationProvider.get(Object) with the muleEvent as the argument.
Optional<RuntimeExtensionModel>	getExtension(String extensionName) Returns an Optional RuntimeExtensionModel which name equals extensionName.
Set<RuntimeExtensionModel>	getExtensions() Returns an immutable Set listing all the discovered extensionModels.
void	registerExtension(ExtensionManifest manifest, ClassLoader classLoader)

Method Detail

registerExtension

void registerExtension(ExtensionManifest manifest,
                       ClassLoader classLoader)

getExtensions

Set<RuntimeExtensionModel> getExtensions()

Returns an immutable Set listing all the discovered extensionModels.

Returns:

an immutable Set. Will not be null but might be empty

getExtension

Optional<RuntimeExtensionModel> getExtension(String extensionName)

Returns an Optional RuntimeExtensionModel which name equals extensionName.

Parameters:

extensionName - the name of the extensions you want.

Returns:

an Optional. It will be empty if no such extension is registered

getConfiguration

ConfigurationInstance getConfiguration(String configurationProviderName,
                                       org.mule.runtime.api.message.MuleEvent muleEvent)

Returns a ConfigurationInstance obtained through a previously registered ConfigurationProvider named as configurationProvider

After the ConfigurationProvider has been located, an instance is returned by invoking its ConfigurationProvider.get(Object) with the muleEvent as the argument.

By the mere fact of this configuration being returned, the value of ConfigurationStats.getLastUsedMillis() will be updated for the returned ConfigurationInstance

Parameters:

configurationProviderName - the name of a previously registered ConfigurationProvider

muleEvent - the current MuleEvent

Returns:

a ConfigurationInstance

getConfiguration

ConfigurationInstance getConfiguration(ExtensionModel extensionModel,
                                       org.mule.runtime.api.message.MuleEvent muleEvent)

Returns a ConfigurationInstance for the given extensionModel.

Because no ConfigurationProvider is specified, the following algorithm will be applied to try and determine the instance to be returned:

• If one ConfigurationProvider is registered, capable of handing configurations of the given extensionModel, then that provider is used
• If more than one ConfigurationProvider meeting the criteria above is found, then a IllegalStateException is thrown
• If no such ConfigurationProvider is registered, then an attempt will be made to locate a ConfigurationModel for which an implicit configuration can be inferred. A model can be considered implicit if all its parameters are either optional or provide a default value. If such a model is found, then a ConfigurationProvider is created and registered for that model.
• If none of the above conditions is met, then an IllegalStateException is thrown

By the mere fact of this configuration being returned, the value of ConfigurationStats.getLastUsedMillis() will be updated for the returned ConfigurationInstance

Parameters:

extensionModel - the ExtensionModel for which a configuration is wanted

muleEvent - the current MuleEvent

Returns:

a ConfigurationInstance

Throws:

IllegalStateException - if none or too many ConfigurationProvider are found to be suitable