org.springframework.boot.context.config

Class ConfigFileApplicationListener

java.lang.Object

org.springframework.boot.context.config.ConfigFileApplicationListener

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>, Ordered

public class ConfigFileApplicationListener
extends Object
implements ApplicationListener<ApplicationEvent>, Ordered

ApplicationListener 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigFileApplicationListener()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPostProcessors(ConfigurableApplicationContext context) Add appropriate post-processors to post-configure the property-sources.
protected void	addProperySources(ConfigurableEnvironment environment) 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(ApplicationEvent event)
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

DEFAULT_ORDER

public static final int DEFAULT_ORDER

See Also:

Constant Field Values

Constructor Detail

ConfigFileApplicationListener

public ConfigFileApplicationListener()

Method Detail

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>

addProperySources

protected void addProperySources(ConfigurableEnvironment environment)

Add config file property sources to the specified environment.

Parameters:

environment - the environment to add source to

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.

setSearchNames

public void setSearchNames(String names)

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