org.mule.runtime.config.spring.internal.dsl.model.config

Class ConfigurationPropertiesComponent

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.config.spring.internal.dsl.model.config.ConfigurationPropertiesComponent

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.meta.AnnotatedObject, ConfigurationPropertiesProvider

public class ConfigurationPropertiesComponent
extends org.mule.runtime.api.meta.AbstractAnnotatedObject
implements ConfigurationPropertiesProvider, org.mule.runtime.api.lifecycle.Initialisable

Artifact attributes configuration. This class represents a single configuration-attributes element from the configuration.

Since:

4.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

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

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesComponent(String fileLocation, ResourceProvider resourceProvider)

Method Summary

Modifier and Type	Method and Description
Optional<ConfigurationProperty>	getConfigurationProperty(String configurationAttributeKey)
String	getDescription()
void	initialise()

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, getRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPropertiesComponent

public ConfigurationPropertiesComponent(String fileLocation,
                                        ResourceProvider resourceProvider)
                                 throws ConfigurationPropertiesException

Throws:

ConfigurationPropertiesException

Method Detail

getConfigurationProperty

public Optional<ConfigurationProperty> getConfigurationProperty(String configurationAttributeKey)

Specified by:

getConfigurationProperty in interface ConfigurationPropertiesProvider

Parameters:

configurationAttributeKey - the key of the configuration attribute.

Returns:

the ConfigurationProperty associated with the key. May be empty if that key is not present.

getDescription

public String getDescription()

Specified by:

getDescription in interface ConfigurationPropertiesProvider

Returns:

a meaningful description of the provider. This is used for error reporting.

initialise

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

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException