Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ConfigDataEnvironmentUpdateListener support
Add an overloaded `ConfigDataEnvironmentPostProcessor.applyTo` method that accepts a listener that can used to track the updates that were applied to the `Environment`. The listener can be used to track the which `ConfigDataLocation` and the `ConfigDataResource` were used to add a `PropertySource`. The lister can also be used to tell which profiles were applied. This enhancement is being added in a patch release because it's will be useful for Spring Cloud 2020.0.0. Closes gh-24504
- Loading branch information
Showing
8 changed files
with
236 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
...ain/java/org/springframework/boot/context/config/ConfigDataEnvironmentUpdateListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.context.config; | ||
|
||
import java.util.EventListener; | ||
|
||
import org.springframework.core.env.Environment; | ||
import org.springframework.core.env.PropertySource; | ||
|
||
/** | ||
* {@link EventListener} to listen to {@link Environment} updates triggered by the | ||
* {@link ConfigDataEnvironmentPostProcessor}. | ||
* | ||
* @author Phillip Webb | ||
* @since 2.4.2 | ||
*/ | ||
public interface ConfigDataEnvironmentUpdateListener extends EventListener { | ||
|
||
/** | ||
* A {@link ConfigDataEnvironmentUpdateListener} that does nothing. | ||
*/ | ||
ConfigDataEnvironmentUpdateListener NONE = new ConfigDataEnvironmentUpdateListener() { | ||
}; | ||
|
||
/** | ||
* Called when a new {@link PropertySource} is added to the {@link Environment}. | ||
* @param propertySource the {@link PropertySource} that was added | ||
* @param location the original {@link ConfigDataLocation} of the source. | ||
* @param resource the {@link ConfigDataResource} of the source. | ||
*/ | ||
default void onPropertySourceAdded(PropertySource<?> propertySource, ConfigDataLocation location, | ||
ConfigDataResource resource) { | ||
} | ||
|
||
/** | ||
* Called when {@link Environment} profiles are set. | ||
* @param profiles the profiles being set | ||
*/ | ||
default void onSetProfiles(Profiles profiles) { | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.