org.springframework.boot.context.config

Class ConfigFileApplicationListener

java.lang.Object

org.springframework.boot.context.config.ConfigFileApplicationListener

All Implemented Interfaces:

EventListener, EnvironmentPostProcessor, ApplicationListener<ApplicationEvent>, SmartApplicationListener, Ordered

Deprecated.

since 2.4.0 for removal in 2.6.0 in favor of ConfigDataEnvironmentPostProcessor

@Deprecated
public class ConfigFileApplicationListener
extends Object
implements EnvironmentPostProcessor, SmartApplicationListener, 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:

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

The list is ordered by precedence (properties defined in locations higher in the list override those defined in lower locations).

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.

Since:

1.0.0

Author:

Dave Syer, Phillip Webb, Stephane Nicoll, Andy Wilkinson, Eddú Meléndez, Madhura Bhave, Scott Frederick

Field Summary

Fields

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

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigFileApplicationListener() Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.event.SmartApplicationListener

getListenerId, supportsSourceType

Methods inherited from interface org.springframework.context.ApplicationListener

forPayload

Field Detail

ACTIVE_PROFILES_PROPERTY

public static final String ACTIVE_PROFILES_PROPERTY

Deprecated.

The "active profiles" property name.

See Also:

Constant Field Values

INCLUDE_PROFILES_PROPERTY

public static final String INCLUDE_PROFILES_PROPERTY

Deprecated.

The "includes profiles" property name.

See Also:

Constant Field Values

CONFIG_NAME_PROPERTY

public static final String CONFIG_NAME_PROPERTY

Deprecated.

The "config name" property name.

See Also:

Constant Field Values

CONFIG_LOCATION_PROPERTY

public static final String CONFIG_LOCATION_PROPERTY

Deprecated.

The "config location" property name.

See Also:

Constant Field Values

CONFIG_ADDITIONAL_LOCATION_PROPERTY

public static final String CONFIG_ADDITIONAL_LOCATION_PROPERTY

Deprecated.

The "config additional location" property name.

See Also:

Constant Field Values

DEFAULT_ORDER

public static final int DEFAULT_ORDER

Deprecated.

The default order for the processor.

See Also:

Constant Field Values

Constructor Detail

ConfigFileApplicationListener

public ConfigFileApplicationListener()

Deprecated.

Method Detail

supportsEventType

public boolean supportsEventType(Class<? extends ApplicationEvent> eventType)

Deprecated.

Specified by:

supportsEventType in interface SmartApplicationListener

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Deprecated.

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>

postProcessEnvironment

public void postProcessEnvironment(ConfigurableEnvironment environment,
                                   SpringApplication application)

Deprecated.

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

addPropertySources

protected void addPropertySources(ConfigurableEnvironment environment,
                                  ResourceLoader resourceLoader)

Deprecated.

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)

addPostProcessors

protected void addPostProcessors(ConfigurableApplicationContext context)

Deprecated.

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

Parameters:

context - the context to configure

setOrder

public void setOrder(int order)

Deprecated.

getOrder

public int getOrder()

Deprecated.

Specified by:

getOrder in interface SmartApplicationListener

Specified by:

getOrder in interface Ordered

setSearchLocations

public void setSearchLocations(String locations)

Deprecated.

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)

Deprecated.

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

Parameters:

names - the names to load