org.mule.runtime.config.api.dsl.model.properties

Interface ConfigurationPropertiesProvider

All Known Implementing Classes:

CompositeConfigurationPropertiesProvider, DefaultConfigurationPropertiesProvider, EnvironmentPropertiesConfigurationProvider, FileConfigurationPropertiesProvider, GlobalPropertyConfigurationPropertiesProvider, MapConfigurationPropertiesProvider

@NoImplement
public interface ConfigurationPropertiesProvider

A provider of configuration attributes.

Configuration attributes must be provided upon request since there may be implementations of this interface that do not have a small number of configuration attributes and doing a lookup of the attributes may not be trivial. Such would be the case of a vault implementation of this interface which will probably lookup for values from a remote entity.

Since:

4.0

Method Summary

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

Method Detail

getConfigurationProperty

Optional<ConfigurationProperty> getConfigurationProperty(String configurationAttributeKey)

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

String getDescription()

Returns:

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