org.mule.runtime.module.extension.internal.runtime.config

Class LifecycleAwareConfigurationProvider

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.module.extension.internal.runtime.config.LifecycleAwareConfigurationProvider

All Implemented Interfaces:

org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.extension.api.runtime.config.ConfigurationProvider

Direct Known Subclasses:

DynamicConfigurationProvider, StaticConfigurationProvider

public abstract class LifecycleAwareConfigurationProvider
extends org.mule.runtime.api.component.AbstractComponent
implements org.mule.runtime.extension.api.runtime.config.ConfigurationProvider, org.mule.runtime.api.lifecycle.Lifecycle

Base class for implementations of ConfigurationProvider which keep track of the ConfigurationInstance they generate and propagate lifecycle and IoC into them.

It also implements the other common concerns of every ConfigurationProvider, leaving implementations with the need to "just" implement ConfigurationProvider.get(Event)

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleLifecycleManager	lifecycleManager
protected MuleContext	muleContext

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
LifecycleAwareConfigurationProvider(String name, org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel, MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
void	dispose() When needed, fires the Disposable.dispose() phase on the currently provided configurations
protected void	doInitialise() Template method so subclasses can do initialisation.
org.mule.runtime.api.meta.model.config.ConfigurationModel	getConfigurationModel()
protected ClassLoader	getExtensionClassLoader()
org.mule.runtime.api.meta.model.ExtensionModel	getExtensionModel()
String	getName()
void	initialise() Performs dependency injection into all the currently provided configurations, and when needed, fires the Initialisable.initialise() phase on them
protected void	registerConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance configuration) Implementations are to invoke this method everytime they create a new ConfigurationInstance so that they're kept track of and the lifecycle can be propagated
void	start() When needed, fires the Startable.start() phase on the currently provided configurations
protected void	startConfig(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance config)
void	stop() When needed, fires the Stoppable.stop() phase on the currently provided configurations
protected boolean	unRegisterConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance configuration) Implementations are to invoke this method every time they want to unregister a current registered ConfigurationInstance so that they're no longer kept track of and the lifecycle is not propagated.

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getLocation, getRootContainerLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.extension.api.runtime.config.ConfigurationProvider

get, isDynamic

Methods inherited from interface org.mule.runtime.api.component.Component

getAnnotation, getAnnotations, getLocation, getRootContainerLocation, setAnnotations

Field Detail

lifecycleManager

protected final SimpleLifecycleManager lifecycleManager

muleContext

protected final MuleContext muleContext

Constructor Detail

LifecycleAwareConfigurationProvider

public LifecycleAwareConfigurationProvider(String name,
                                           org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                           org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel,
                                           MuleContext muleContext)

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Performs dependency injection into all the currently provided configurations, and when needed, fires the Initialisable.initialise() phase on them

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException - if an exception is found

doInitialise

protected void doInitialise()

Template method so subclasses can do initialisation.

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

When needed, fires the Startable.start() phase on the currently provided configurations

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException - if an exception is found

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

When needed, fires the Stoppable.stop() phase on the currently provided configurations

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException - if an exception is found

dispose

public void dispose()

When needed, fires the Disposable.dispose() phase on the currently provided configurations

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

registerConfiguration

protected void registerConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance configuration)

Implementations are to invoke this method everytime they create a new ConfigurationInstance so that they're kept track of and the lifecycle can be propagated

Parameters:

configuration - a newly created ConfigurationInstance

unRegisterConfiguration

protected boolean unRegisterConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance configuration)

Implementations are to invoke this method every time they want to unregister a current registered ConfigurationInstance so that they're no longer kept track of and the lifecycle is not propagated.

Parameters:

configuration - an already registered ConfigurationInstance

Returns:

whether a ConfigurationInstance was unregistered or not.

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.extension.api.runtime.config.ConfigurationProvider

getConfigurationModel

public org.mule.runtime.api.meta.model.config.ConfigurationModel getConfigurationModel()

Specified by:

getConfigurationModel in interface org.mule.runtime.extension.api.runtime.config.ConfigurationProvider

getExtensionModel

public org.mule.runtime.api.meta.model.ExtensionModel getExtensionModel()

Specified by:

getExtensionModel in interface org.mule.runtime.extension.api.runtime.config.ConfigurationProvider

startConfig

protected void startConfig(org.mule.runtime.extension.api.runtime.config.ConfigurationInstance config)
                    throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

getExtensionClassLoader

protected ClassLoader getExtensionClassLoader()