org.broadleafcommerce.common.config

Class FrameworkCommonPropertySource

java.lang.Object

org.broadleafcommerce.common.config.FrameworkCommonPropertySource

All Implemented Interfaces:

org.springframework.core.Ordered

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

A holder for common.properties location. This assumes that this is from the current classpath as this drives the creation of a ClassPathResource. Example:

 @Configuration
 public class ModuleProperties {
     @Bean
     public static FrameworkCommonPropertySource blModuleProps() {
         return new FrameworkCommonPropertySource("config/bc/module");
     }
 }
 
 

 This is used to derive special meaning in the ProfileAwarePropertiesBeanFactoryPostProcessor where they are
 added to the active Spring Environment.
 
 

 Any properties resolved by these classes have a lower precedence than any ProfileAwarePropertySource.
 
 

 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. Also note that the registration of this @Bean method is static since
 it should follow the same registration rules of a BeanFactoryPostProcessor.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

ProfileAwarePropertiesBeanFactoryPostProcessor}, ProfileAwarePropertySource}

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADMIN_MODULE_ORDER
static int	BROADLEAF_COMMON_ORDER All of the property configurations registered by the core framework (e.g.
protected String	classpathFolder
static int	CMS_ORDER
static int	DEFAULT_ORDER
static int	FRAMEWORK_ORDER
static int	FRAMEWORK_WEB_ORDER
static int	OPEN_ADMIN_ORDER
protected int	order
static int	PROFILE_ORDER
static int	PROFILE_WEB_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
FrameworkCommonPropertySource(String classpathFolder)
FrameworkCommonPropertySource(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

BROADLEAF_COMMON_ORDER

public static final int BROADLEAF_COMMON_ORDER

All of the property configurations registered by the core framework (e.g. broadleaf-framework, broadleaf-common, broadleaf-open-admin-platform, etc) have this ordering. This ordering is mainly for backwards-compatibilty's sake, as this was the ordering essentially defined in the old StandardConfigLocations

See Also:

Constant Field Values

PROFILE_ORDER

public static final int PROFILE_ORDER

See Also:

Constant Field Values

PROFILE_WEB_ORDER

public static final int PROFILE_WEB_ORDER

See Also:

Constant Field Values

FRAMEWORK_ORDER

public static final int FRAMEWORK_ORDER

See Also:

Constant Field Values

FRAMEWORK_WEB_ORDER

public static final int FRAMEWORK_WEB_ORDER

See Also:

Constant Field Values

OPEN_ADMIN_ORDER

public static final int OPEN_ADMIN_ORDER

See Also:

Constant Field Values

ADMIN_MODULE_ORDER

public static final int ADMIN_MODULE_ORDER

See Also:

Constant Field Values

CMS_ORDER

public static final int CMS_ORDER

See Also:

Constant Field Values

DEFAULT_ORDER

public static final int DEFAULT_ORDER

See Also:

Constant Field Values

classpathFolder

protected String classpathFolder

order

protected int order

Constructor Detail

FrameworkCommonPropertySource

public FrameworkCommonPropertySource(String classpathFolder)

FrameworkCommonPropertySource

public FrameworkCommonPropertySource(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