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

Class DynamicConfigurationProvider

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

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

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

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, org.mule.runtime.extension.api.runtime.config.ExpirableConfigurationProvider, org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

public final class DynamicConfigurationProvider
extends LifecycleAwareConfigurationProvider
implements org.mule.runtime.extension.api.runtime.config.ExpirableConfigurationProvider, org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

A ConfigurationProvider which continuously evaluates the same ResolverSet and then uses the resulting ResolverSetResult to build an instance of type T

Although each invocation to get(Event) is guaranteed to end up in an invocation to #resolverSet#resolve(Object), the resulting ResolverSetResult might not end up generating a new instance. This is so because ResolverSetResult instances are put in a cache to guarantee that equivalent evaluations of the resolverSet return the same instance.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields inherited from class org.mule.runtime.module.extension.internal.runtime.config.LifecycleAwareConfigurationProvider

lifecycleManager, muleContext

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

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

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

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

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

DynamicConfigurationProvider(String name, org.mule.runtime.api.meta.model.ExtensionModel extension, org.mule.runtime.api.meta.model.config.ConfigurationModel config, ResolverSet resolverSet, ConnectionProviderValueResolver connectionProviderResolver, org.mule.runtime.extension.api.runtime.ExpirationPolicy expirationPolicy, ReflectionCache reflectionCache, ExpressionManager expressionManager, MuleContext muleContext) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	doInitialise() Template method so subclasses can do initialisation.
org.mule.runtime.extension.api.runtime.config.ConfigurationInstance	get(org.mule.runtime.api.event.Event event) Evaluates resolverSet using the given event and returns an instance produced with the result.
Set<org.mule.runtime.api.value.Value>	getConfigValues(String parameterName)
Set<org.mule.runtime.api.value.Value>	getConfigValues(String parameterName, String targetSelector)
Set<org.mule.runtime.api.value.Value>	getConnectionValues(String parameterName)
Set<org.mule.runtime.api.value.Value>	getConnectionValues(String parameterName, String targetSelector)
List<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance>	getExpired()
boolean	isDynamic()
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

Methods inherited from class org.mule.runtime.module.extension.internal.runtime.config.LifecycleAwareConfigurationProvider

dispose, getConfigurationModel, getExtensionClassLoader, getExtensionModel, getName, initialise, startConfig, stop, unRegisterConfiguration

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

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, 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

getConfigurationModel, getExtensionModel, getName

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

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, setAnnotations

Methods inherited from interface org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

getConfigModels, getConnectionModels

Constructor Detail

DynamicConfigurationProvider

public DynamicConfigurationProvider(String name,
                                    org.mule.runtime.api.meta.model.ExtensionModel extension,
                                    org.mule.runtime.api.meta.model.config.ConfigurationModel config,
                                    ResolverSet resolverSet,
                                    ConnectionProviderValueResolver connectionProviderResolver,
                                    org.mule.runtime.extension.api.runtime.ExpirationPolicy expirationPolicy,
                                    ReflectionCache reflectionCache,
                                    ExpressionManager expressionManager,
                                    MuleContext muleContext)

Creates a new instance

Parameters:

name - this provider's name

extension - the model that owns the configurationModel

config - the model for the returned configurations

resolverSet - the ResolverSet that provides the configuration's parameter values

connectionProviderResolver - a ValueResolver used to obtain a ConnectionProvider

expirationPolicy - the ExpirationPolicy for the unused instances

reflectionCache - the ReflectionCache used to improve reflection lookups performance

expressionManager - the ExpressionManager used to create a session used to evaluate the attributes.

muleContext - the MuleContext that will own the configuration instances

Method Detail

get

public org.mule.runtime.extension.api.runtime.config.ConfigurationInstance get(org.mule.runtime.api.event.Event event)

Evaluates resolverSet using the given event and returns an instance produced with the result. For equivalent ResolverSetResults it will return the same instance.

Specified by:

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

Parameters:

event - the current event

Returns:

the resolved ConfigurationInstance

registerConfiguration

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

Description copied from class: LifecycleAwareConfigurationProvider

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

Overrides:

registerConfiguration in class LifecycleAwareConfigurationProvider

Parameters:

configuration - a newly created ConfigurationInstance

getExpired

public List<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> getExpired()

Specified by:

getExpired in interface org.mule.runtime.extension.api.runtime.config.ExpirableConfigurationProvider

doInitialise

protected void doInitialise()

Description copied from class: LifecycleAwareConfigurationProvider

Template method so subclasses can do initialisation.

Overrides:

doInitialise in class LifecycleAwareConfigurationProvider

start

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

Description copied from class: LifecycleAwareConfigurationProvider

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

Specified by:

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

Overrides:

start in class LifecycleAwareConfigurationProvider

Throws:

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

isDynamic

public boolean isDynamic()

Specified by:

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

Returns:

false

getConfigValues

public Set<org.mule.runtime.api.value.Value> getConfigValues(String parameterName)
                                                      throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

getConfigValues in interface org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException

getConfigValues

public Set<org.mule.runtime.api.value.Value> getConfigValues(String parameterName,
                                                             String targetSelector)
                                                      throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

getConfigValues in interface org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException

getConnectionValues

public Set<org.mule.runtime.api.value.Value> getConnectionValues(String parameterName)
                                                          throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

getConnectionValues in interface org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException

getConnectionValues

public Set<org.mule.runtime.api.value.Value> getConnectionValues(String parameterName,
                                                                 String targetSelector)
                                                          throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

getConnectionValues in interface org.mule.runtime.extension.api.values.ConfigurationParameterValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException