org.springframework.boot.context.config

Class ConfigDataEnvironmentPostProcessor

java.lang.Object

org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor

All Implemented Interfaces:

EnvironmentPostProcessor, Ordered

public class ConfigDataEnvironmentPostProcessor
extends Object
implements EnvironmentPostProcessor, Ordered

EnvironmentPostProcessor that loads and applies ConfigData to Spring's Environment.

Since:

2.4.0

Author:

Phillip Webb, Madhura Bhave, Nguyen Bao Sach

Field Summary

Fields

Modifier and Type	Field and Description
static String	ON_LOCATION_NOT_FOUND_PROPERTY Property used to determine what action to take when a ConfigDataLocationNotFoundException is thrown.
static int	ORDER The default order for the processor.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory, ConfigurableBootstrapContext bootstrapContext)
ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory, ConfigurableBootstrapContext bootstrapContext, ConfigDataEnvironmentUpdateListener environmentUpdateListener)

Method Summary

Modifier and Type	Method and Description
static void	applyTo(ConfigurableEnvironment environment) Apply ConfigData post-processing to an existing Environment.
static void	applyTo(ConfigurableEnvironment environment, ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, Collection<String> additionalProfiles) Apply ConfigData post-processing to an existing Environment.
static void	applyTo(ConfigurableEnvironment environment, ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, Collection<String> additionalProfiles, ConfigDataEnvironmentUpdateListener environmentUpdateListener) Apply ConfigData post-processing to an existing Environment.
static void	applyTo(ConfigurableEnvironment environment, ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, String... additionalProfiles) Apply ConfigData post-processing to an existing Environment.
int	getOrder()
void	postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) Post-process the given environment.

Methods inherited from class java.lang.Object

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

Field Detail

ORDER

public static final int ORDER

The default order for the processor.

See Also:

Constant Field Values

ON_LOCATION_NOT_FOUND_PROPERTY

public static final String ON_LOCATION_NOT_FOUND_PROPERTY

Property used to determine what action to take when a ConfigDataLocationNotFoundException is thrown.

See Also:

ConfigDataNotFoundAction, Constant Field Values

Constructor Detail

ConfigDataEnvironmentPostProcessor

public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory,
                                          ConfigurableBootstrapContext bootstrapContext)

ConfigDataEnvironmentPostProcessor

public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory,
                                          ConfigurableBootstrapContext bootstrapContext,
                                          ConfigDataEnvironmentUpdateListener environmentUpdateListener)

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

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

applyTo

public static void applyTo(ConfigurableEnvironment environment)

Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.

Parameters:

environment - the environment to apply ConfigData to

applyTo

public static void applyTo(ConfigurableEnvironment environment,
                           ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           String... additionalProfiles)

Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.

Parameters:

environment - the environment to apply ConfigData to

resourceLoader - the resource loader to use

bootstrapContext - the bootstrap context to use or null to use a throw-away context

additionalProfiles - any additional profiles that should be applied

applyTo

public static void applyTo(ConfigurableEnvironment environment,
                           ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           Collection<String> additionalProfiles)

Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.

Parameters:

environment - the environment to apply ConfigData to

resourceLoader - the resource loader to use

bootstrapContext - the bootstrap context to use or null to use a throw-away context

additionalProfiles - any additional profiles that should be applied

applyTo

public static void applyTo(ConfigurableEnvironment environment,
                           ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           Collection<String> additionalProfiles,
                           ConfigDataEnvironmentUpdateListener environmentUpdateListener)

Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.

Parameters:

environment - the environment to apply ConfigData to

resourceLoader - the resource loader to use

bootstrapContext - the bootstrap context to use or null to use a throw-away context

additionalProfiles - any additional profiles that should be applied

environmentUpdateListener - optional ConfigDataEnvironmentUpdateListener that can be used to track Environment updates.