org.broadleafcommerce.common.config

Class ProfileAwarePropertySource

java.lang.Object

org.broadleafcommerce.common.config.ProfileAwarePropertySource

All Implemented Interfaces:

org.springframework.core.Ordered

public class ProfileAwarePropertySource
extends Object
implements org.springframework.core.Ordered

Holder for a folder of properties resources comprised of something like the following on the classpath:

• classpath:/runtime-properties/
• common.properties
• common-shared.properties
• [profile].properties
• [profile]-shared.properties

Where the [environment] is a key that is resolved from the current Spring profile. Given that set of properties, they get ordered in the following way:

• classpath:/runtime-properties/
1. common-shared.properties
2. common.properties
3. [profile]-shared.properties
4. [profile].properties

If you are using Spring boot, this is a deprecated construct and instead you should rely on application.properties and the profile-specific variants of that. Registration is the same as FrameworkCommonPropertySource.

Properties registered via this ProfileAwarePropertySource is functionally equivalent to registering them via PropertySource and have the same ordering semantics as "@PropertySource annotations on your @Configuration classes. The exception is that these are also guaranteed to take a higher precedence than FrameworkCommonPropertySource.

There is generally only a single one of these beans registered in the application. If multiple of them are registered, they are ordered based on getOrder() and all properties are added to the Environment prior to moving to the next ProfileAwarePropertySource.

These are guaranteed to take a higher precedence (and thus override) properties registered via FrameworkCommonPropertySource

These bean instances are created very early in the Spring lifecycle, during BeanFactoryPostProcessor instantiation. Therefore you should not be doing any complicated bean logic here (instantating dependencies, trying to @Autowire anything, etc) or else you might run into unintended consequences.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

ProfileAwarePropertiesBeanFactoryPostProcessor}

Field Summary

Fields

Modifier and Type	Field and Description
protected String	classpathFolder
static int	DEFAULT_ORDER
protected int	order

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ProfileAwarePropertySource(String classpathFolder)
ProfileAwarePropertySource(String classpathFolder, int order)

Method Summary

Methods

Modifier and Type	Method and Description
String	getClasspathFolder()
int	getOrder() Semantics of this ordering are slightly different than others.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

See Also:

Constant Field Values

classpathFolder

protected String classpathFolder

order

protected int order

Constructor Detail

ProfileAwarePropertySource

public ProfileAwarePropertySource(String classpathFolder)

ProfileAwarePropertySource

public ProfileAwarePropertySource(String classpathFolder,
                          int order)

Method Detail

getClasspathFolder

public String getClasspathFolder()

getOrder

public int getOrder()

Semantics of this ordering are slightly different than others. In this case, a higher order means that this is registered later within ProfileAwarePropertiesBeanFactoryPostProcessor which means that it has a higher resolution precedence.

Specified by:

getOrder in interface org.springframework.core.Ordered