org.mule.runtime.config.api.properties

Class ConfigurationPropertiesHierarchyBuilder

java.lang.Object

org.mule.runtime.config.api.properties.ConfigurationPropertiesHierarchyBuilder

public class ConfigurationPropertiesHierarchyBuilder
extends Object

Builder of ConfigurationPropertiesResolver with the full hierarchy, considering the properties to be used. The hierarchy to consider is:

1. Deployment Properties
2. System Properties
3. Environment Properties
4. Application Properties (this includes file properties)
5. Global (Default) Properties

This means that (for example) if we have a property 'hello' both in System Properties level and Application Properties level, then the value to be use is going to be the System Properties one. Also, lower-hierarchy properties can depend their values on higher level properties (e.g. an application property can depend its value on a system property)

Since:

4.5

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesHierarchyBuilder()

Method Summary

Modifier and Type	Method and Description
ConfigurationPropertiesResolver	build()
ConfigurationPropertiesHierarchyBuilder	withApplicationProperties(org.mule.runtime.properties.api.ConfigurationPropertiesProvider provider) Sets a ConfigurationPropertiesProvider to use as application property, gotten from a custom provider (such as the Secure Configuration Properties) or properties set with the configuration-properties tag.
ConfigurationPropertiesHierarchyBuilder	withDeploymentProperties(Map<String,String> properties)
ConfigurationPropertiesHierarchyBuilder	withDomainPropertiesResolver(org.mule.runtime.api.component.ConfigurationProperties domainProperties) Sets to consider the domain properties in the hierarchy, setting a previously resolved ConfigurationProperty to reoslve.
ConfigurationPropertiesHierarchyBuilder	withEnvironmentProperties() Sets that environment properties (from OS) should be considered in the hierarchy.
ConfigurationPropertiesHierarchyBuilder	withGlobalPropertiesSupplier(Supplier<Map<String,org.mule.runtime.properties.api.ConfigurationProperty>> globalPropertiesSupplier) Sets a supplier to retrieve the Global Properties from.
ConfigurationPropertiesHierarchyBuilder	withoutFailuresIfPropertyNotPresent() Set that the ConfigurationPropertiesResolver to be built won't fail in case of resolving a property doesn't exist.
ConfigurationPropertiesHierarchyBuilder	withPropertiesFile(org.mule.runtime.properties.api.ResourceProvider resourceProvider) Sets an external resource provider to get the file content to then use a File Configuration Property.
ConfigurationPropertiesHierarchyBuilder	withSystemProperties() Sets that system properties added to the JVM are considered in the hierarchy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPropertiesHierarchyBuilder

public ConfigurationPropertiesHierarchyBuilder()

Method Detail

withDeploymentProperties

public ConfigurationPropertiesHierarchyBuilder withDeploymentProperties(Map<String,String> properties)

Parameters:

properties - the deployment properties to consider, as a map.

Returns:

this builder.

withSystemProperties

public ConfigurationPropertiesHierarchyBuilder withSystemProperties()

Sets that system properties added to the JVM are considered in the hierarchy.

Returns:

this builder.

withEnvironmentProperties

public ConfigurationPropertiesHierarchyBuilder withEnvironmentProperties()

Sets that environment properties (from OS) should be considered in the hierarchy.

Returns:

this builder.

withPropertiesFile

public ConfigurationPropertiesHierarchyBuilder withPropertiesFile(org.mule.runtime.properties.api.ResourceProvider resourceProvider)

Sets an external resource provider to get the file content to then use a File Configuration Property.

Parameters:

resourceProvider - the ResourceProvider to use to read the files to use when resolving a file-value property.

Returns:

this builder.

withApplicationProperties

public ConfigurationPropertiesHierarchyBuilder withApplicationProperties(org.mule.runtime.properties.api.ConfigurationPropertiesProvider provider)

Sets a ConfigurationPropertiesProvider to use as application property, gotten from a custom provider (such as the Secure Configuration Properties) or properties set with the configuration-properties tag.

Parameters:

provider - the ConfigurationPropertiesProvider to add to the hierarchy as Application Properties.

Returns:

this builder.

withGlobalPropertiesSupplier

public ConfigurationPropertiesHierarchyBuilder withGlobalPropertiesSupplier(Supplier<Map<String,org.mule.runtime.properties.api.ConfigurationProperty>> globalPropertiesSupplier)

Sets a supplier to retrieve the Global Properties from.

Parameters:

globalPropertiesSupplier - a Supplier of a Map of properties, to be used as Global/Default properties.

Returns:

this builder.

withDomainPropertiesResolver

public ConfigurationPropertiesHierarchyBuilder withDomainPropertiesResolver(org.mule.runtime.api.component.ConfigurationProperties domainProperties)

Sets to consider the domain properties in the hierarchy, setting a previously resolved ConfigurationProperty to reoslve.

Parameters:

domainProperties - the ConfigurationProperties previously generated for the domain, to be used in this hierarchy.

Returns:

this builder.

withoutFailuresIfPropertyNotPresent

public ConfigurationPropertiesHierarchyBuilder withoutFailuresIfPropertyNotPresent()

Set that the ConfigurationPropertiesResolver to be built won't fail in case of resolving a property doesn't exist. Instead of throwing a PropertyNotFoundException, it will return null.

Returns:

this builder.

build

public ConfigurationPropertiesResolver build()

Returns:

the built ConfigurationPropertiesResolver that includes the complete hierarchy with the defined resolvers.