org.springframework.boot.context.config

Class ConfigFileEnvironmentPostProcessor

java.lang.Object

org.springframework.boot.context.config.ConfigFileEnvironmentPostProcessor

All Implemented Interfaces:

EventListener, EnvironmentPostProcessor, ApplicationListener<ApplicationPreparedEvent>, Ordered

public class ConfigFileEnvironmentPostProcessor
extends Object
implements EnvironmentPostProcessor, ApplicationListener<ApplicationPreparedEvent>, Ordered

EnvironmentPostProcessor that configures the context environment by loading properties from well known file locations. By default properties will be loaded from 'application.properties' and/or 'application.yml' files in the following locations:

• classpath:
• file:./
• classpath:config/
• file:./config/:

Alternative search locations and names can be specified using setSearchLocations(String) and setSearchNames(String).

Additional files will also be loaded based on active profiles. For example if a 'web' profile is active 'application-web.properties' and 'application-web.yml' will be considered.

The 'spring.config.name' property can be used to specify an alternative name to load and the 'spring.config.location' property can be used to specify alternative search locations or specific files.

Configuration properties are also bound to the SpringApplication. This makes it possible to set SpringApplication properties dynamically, like the sources ("spring.main.sources" - a CSV list) the flag to indicate a web environment ("spring.main.web_environment=true") or the flag to switch off the banner ("spring.main.show_banner=false").

Author:

Dave Syer, Phillip Webb, Stephane Nicoll, Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_PROFILES_PROPERTY The "active profiles" property name.
static String	CONFIG_LOCATION_PROPERTY The "config location" property name.
static String	CONFIG_NAME_PROPERTY The "config name" property name.
static int	DEFAULT_ORDER The default order for the processor.
static String	INCLUDE_PROFILES_PROPERTY The "includes profiles" property name.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigFileEnvironmentPostProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addPostProcessors(ConfigurableApplicationContext context) Add appropriate post-processors to post-configure the property-sources.
protected void	addPropertySources(ConfigurableEnvironment environment, ResourceLoader resourceLoader) Add config file property sources to the specified environment.
protected void	bindToSpringApplication(ConfigurableEnvironment environment, SpringApplication application) Bind the environment to the SpringApplication.
int	getOrder()
void	onApplicationEvent(ApplicationPreparedEvent event)
void	postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) Post-process the given environment.
void	setOrder(int order)
void	setSearchLocations(String locations) Set the search locations that will be considered as a comma-separated list.
void	setSearchNames(String names) Sets the names of the files that should be loaded (excluding file extension) as a comma-separated list.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVE_PROFILES_PROPERTY

public static final String ACTIVE_PROFILES_PROPERTY

The "active profiles" property name.

See Also:

Constant Field Values

INCLUDE_PROFILES_PROPERTY

public static final String INCLUDE_PROFILES_PROPERTY

The "includes profiles" property name.

See Also:

Constant Field Values

CONFIG_NAME_PROPERTY

public static final String CONFIG_NAME_PROPERTY

The "config name" property name.

See Also:

Constant Field Values

CONFIG_LOCATION_PROPERTY

public static final String CONFIG_LOCATION_PROPERTY

The "config location" property name.

See Also:

Constant Field Values

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order for the processor.

See Also:

Constant Field Values

Constructor Detail

ConfigFileEnvironmentPostProcessor

public ConfigFileEnvironmentPostProcessor()

Method Detail

postProcessEnvironment

public void postProcessEnvironment(ConfigurableEnvironment environment,
                                   SpringApplication application)

Description copied from interface: EnvironmentPostProcessor

Post-process the given environment.

Specified by:

postProcessEnvironment in interface EnvironmentPostProcessor

Parameters:

environment - the environment to post-process

application - the application to which the environment belongs

onApplicationEvent

public void onApplicationEvent(ApplicationPreparedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationPreparedEvent>

addPropertySources

protected void addPropertySources(ConfigurableEnvironment environment,
                                  ResourceLoader resourceLoader)

Add config file property sources to the specified environment.

Parameters:

environment - the environment to add source to

resourceLoader - the resource loader

See Also:

addPostProcessors(ConfigurableApplicationContext)

bindToSpringApplication

protected void bindToSpringApplication(ConfigurableEnvironment environment,
                                       SpringApplication application)

Bind the environment to the SpringApplication.

Parameters:

environment - the environment to bind

application - the application to bind to

addPostProcessors

protected void addPostProcessors(ConfigurableApplicationContext context)

Add appropriate post-processors to post-configure the property-sources.

Parameters:

context - the context to configure

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setSearchLocations

public void setSearchLocations(String locations)

Set the search locations that will be considered as a comma-separated list. Each search location should be a directory path (ending in "/") and it will be prefixed by the file names constructed from search names and profiles (if any) plus file extensions supported by the properties loaders. Locations are considered in the order specified, with later items taking precedence (like a map merge).

Parameters:

locations - the search locations

setSearchNames

public void setSearchNames(String names)

Sets the names of the files that should be loaded (excluding file extension) as a comma-separated list.

Parameters:

names - the names to load