Package org.broadleafcommerce.common.config

Interface FrameworkCommonClasspathPropertySource

All Known Implementing Classes:
BroadleafCommonPropertySource, CmsProperties, DefaultOrderFrameworkCommonClasspathPropertySource, FrameworkConfig.FrameworkPropertySource, FrameworkWebProperties, OpenAdminProperties
public interface FrameworkCommonClasspathPropertySource

A holder for a folder containing a common.properties file to be added to the Spring Environment in a programmatic way without Spring Boot and with very specific ordering semantics. This is generally only used within the Broadleaf Framework and supporting modules. This assumes that the location is on the classpath as this drives the creation of a ClassPathResource. To write your custom one of these, implementations should add an entry to META-INF/spring.factories like: 

 org.broadleafcommerce.common.config.FrameworkCommonClasspathPropertySource=org.broadleafcommerce.common.config.BroadleafCommonPropertySource

Any properties resolved by these classes have a lower precedence than any BroadleafSharedOverrideProfileAwarePropertySource. However, these have a higher precedence than any @PropertySource annotations. Given the ordering mentioned in this Spring Boot doc properties resolved by these classes come immediately before the @PropertySource annotations.

Since:
5.2
Author:
Phillip Verheyden (phillipuniverse)

  • Field Details

    • BROADLEAF_COMMON_ORDER

      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.txt

      See Also:

    • PROFILE_ORDER

      static final int PROFILE_ORDER
      See Also:

    • PROFILE_WEB_ORDER

      static final int PROFILE_WEB_ORDER
      See Also:

    • FRAMEWORK_ORDER

      static final int FRAMEWORK_ORDER
      See Also:

    • FRAMEWORK_WEB_ORDER

      static final int FRAMEWORK_WEB_ORDER
      See Also:

    • OPEN_ADMIN_ORDER

      static final int OPEN_ADMIN_ORDER
      See Also:

    • ADMIN_MODULE_ORDER

      static final int ADMIN_MODULE_ORDER
      See Also:

    • CMS_ORDER

      static final int CMS_ORDER
      See Also:

    • DEFAULT_ORDER

      static final int DEFAULT_ORDER
      See Also:

  • Method Details

    • getClasspathFolder

      String getClasspathFolder()
      A folder on the classpath that contains a common.properties file. Note that this cannot be prefixed with "classpath:" or any of those varieties since this drives the creation of an ClassPathResource already based on this location.