Package org.springframework.boot.context.config

Interface ConfigDataEnvironmentUpdateListener

All Superinterfaces:

EventListener

public interface ConfigDataEnvironmentUpdateListener
extends EventListener

EventListener to listen to Environment updates triggered by the ConfigDataEnvironmentPostProcessor.

Since:

2.4.2

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigDataEnvironmentUpdateListener	NONE	A ConfigDataEnvironmentUpdateListener that does nothing.

Method Summary

Modifier and Type	Method	Description
default ConfigData.Options	onConfigDataOptions(ConfigData configData, org.springframework.core.env.PropertySource<?> propertySource, ConfigData.Options options)	Called when config data options are obtained for a particular property source.
default void	onPropertySourceAdded(org.springframework.core.env.PropertySource<?> propertySource, ConfigDataLocation location, ConfigDataResource resource)	Called when a new PropertySource is added to the Environment.
default void	onSetProfiles(Profiles profiles)	Called when Environment profiles are set.

Field Details

NONE

static final ConfigDataEnvironmentUpdateListener NONE

A ConfigDataEnvironmentUpdateListener that does nothing.

Method Details

onPropertySourceAdded

default void onPropertySourceAdded(org.springframework.core.env.PropertySource<?> propertySource,
 ConfigDataLocation location,
 ConfigDataResource resource)

Called when a new PropertySource is added to the Environment.

Parameters:

propertySource - the PropertySource that was added

location - the original ConfigDataLocation of the source.

resource - the ConfigDataResource of the source.

onSetProfiles

default void onSetProfiles(Profiles profiles)

Called when Environment profiles are set.

Parameters:

profiles - the profiles being set

onConfigDataOptions

default ConfigData.Options onConfigDataOptions(ConfigData configData,
 org.springframework.core.env.PropertySource<?> propertySource,
 ConfigData.Options options)

Called when config data options are obtained for a particular property source.

Parameters:

configData - the config data

propertySource - the property source

options - the options as provided by ConfigData.getOptions(PropertySource)

Returns:

the actual options that should be used

Since:

3.5.1