org.mule.runtime.properties.api

Interface ConfigurationPropertiesProvider

All Known Implementing Classes:

DefaultConfigurationPropertiesProvider

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.

Implementations may also implement Initialisable and/or Disposable to create, keep and destroy any context that is required to properly resolve the properties.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
String	getDescription()
Optional<? extends ConfigurationProperty>	provide(String configurationAttributeKey)

Method Detail

provide

Optional<? extends ConfigurationProperty> provide(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.