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

Class ConfigurationInstanceFactory<T>

java.lang.Object

org.mule.runtime.module.extension.internal.runtime.config.ConfigurationInstanceFactory<T>

Type Parameters:

T - the generic type of the returned ConfigurationInstance instances

public final class ConfigurationInstanceFactory<T>
extends Object

Reusable and thread-safe factory that creates instances of ConfigurationInstance

The created instances will be of concrete type LifecycleAwareConfigurationInstance, which means that all the interceptor factories obtained through the InterceptorsModelProperty (if present) will be exercised per each created instance

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
ConfigurationInstanceFactory(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel, ResolverSet resolverSet, MuleContext muleContext) Creates a new instance which provides instances derived from the given configurationModel and resolverSet

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.ConfigurationInstance	createConfiguration(String name, Event event) Creates a new instance using the given event to obtain the configuration's parameter values.
org.mule.runtime.extension.api.runtime.ConfigurationInstance	createConfiguration(String name, Event event, ValueResolver<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderResolver) Creates a new instance using the given event to obtain the configuration's parameter values.
org.mule.runtime.extension.api.runtime.ConfigurationInstance	createConfiguration(String name, ResolverSetResult resolverSetResult, Optional<org.mule.runtime.api.connection.ConnectionProvider> connectionProvider) Creates a new instance using the given resolverSetResult to obtain the configuration's parameter values

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationInstanceFactory

public ConfigurationInstanceFactory(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                    org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel,
                                    ResolverSet resolverSet,
                                    MuleContext muleContext)

Creates a new instance which provides instances derived from the given configurationModel and resolverSet

Parameters:

configurationModel - the ConfigurationModel that describes the configurations to be created

resolverSet - the ResolverSet which provides the values for the configuration's parameters

Method Detail

createConfiguration

public org.mule.runtime.extension.api.runtime.ConfigurationInstance createConfiguration(String name,
                                                                                        Event event)
                                                                                 throws org.mule.runtime.api.exception.MuleException

Creates a new instance using the given event to obtain the configuration's parameter values.

This method tries to automatically infer a ConnectionProvider. The first step is to determine if the ExtensionModel which owns the configurationModel has any OperationModel which requires a connection. If the answer is no, then it just provides a null connection provider. Otherwise, it uses a ImplicitConnectionProviderFactory to construct an implicit ConnectionProvider.

Parameters:

name - the name of the configuration to return

event - the current Event

Returns:

a ConfigurationInstance

Throws:

org.mule.runtime.api.exception.MuleException - if an error is encountered

createConfiguration

public org.mule.runtime.extension.api.runtime.ConfigurationInstance createConfiguration(String name,
                                                                                        Event event,
                                                                                        ValueResolver<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderResolver)
                                                                                 throws org.mule.runtime.api.exception.MuleException

Creates a new instance using the given event to obtain the configuration's parameter values.

This method overload allows specifying a ValueResolver to provide the ConnectionProvider that the configuration will use to obtain connections. If the connection does not need such a concept you can provide a null

Parameters:

name - the name of the configuration to return

event - the current Event

connectionProviderResolver - a ValueResolver to provide the ConnectionProvider or null

Returns:

a ConfigurationInstance

Throws:

org.mule.runtime.api.exception.MuleException - if an error is encountered

createConfiguration

public org.mule.runtime.extension.api.runtime.ConfigurationInstance createConfiguration(String name,
                                                                                        ResolverSetResult resolverSetResult,
                                                                                        Optional<org.mule.runtime.api.connection.ConnectionProvider> connectionProvider)
                                                                                 throws org.mule.runtime.api.exception.MuleException

Creates a new instance using the given resolverSetResult to obtain the configuration's parameter values

Parameters:

name - the name of the configuration to return

resolverSetResult - the ResolverSetResult with previously evaluated values

Returns:

a ConfigurationInstance

Throws:

org.mule.runtime.api.exception.MuleException - if an error is encountered