org.mule.runtime.extension.api.runtime.config

Interface ConfigurationProvider

All Superinterfaces:

org.mule.runtime.api.component.Component

All Known Subinterfaces:

ExpirableConfigurationProvider

@NoImplement
public interface ConfigurationProvider
extends org.mule.runtime.api.component.Component

A component responsible for providing instances which are realizations of a given ConfigurationModel.

Instances are provided through the get(Event) method. When that method is invoked, it's up to each implementation to return a brand new instance or one which has already been returned before.

Since:

1.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 interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Method Summary

Modifier and Type	Method and Description
ConfigurationInstance	get(org.mule.runtime.api.event.Event event) Returns a ConfigurationInstance This method may return an instance already returned in the past or a brand new one.
org.mule.runtime.api.meta.model.config.ConfigurationModel	getConfigurationModel()
org.mule.runtime.api.meta.model.ExtensionModel	getExtensionModel()
String	getName() The name under which this provider has been registered
boolean	isDynamic()

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

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

Method Detail

get

ConfigurationInstance get(org.mule.runtime.api.event.Event event)

Returns a ConfigurationInstance

This method may return an instance already returned in the past or a brand new one.

Parameters:

event - the event which processing requires the instance

Returns:

a ConfigurationInstance

getExtensionModel

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

Returns:

the ExtensionModel which owns the getConfigurationModel()

getConfigurationModel

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

Returns:

the ConfigurationModel for the instances returned by get(Event)

getName

String getName()

The name under which this provider has been registered

Returns:

this provider's name

isDynamic

boolean isDynamic()

Returns:

Whether the returned config is dynamic or static