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-24504pull/24597/head
Phillip Webb
4 years ago
parent
5e1a69e90e
commit
38e4c2a179
@ -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) {
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,79 @@
|
||||
/*
|
||||
* 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.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.core.env.PropertySource;
|
||||
|
||||
class TestConfigDataEnvironmentUpdateListener implements ConfigDataEnvironmentUpdateListener {
|
||||
|
||||
private final List<AddedPropertySource> addedPropertySources = new ArrayList<>();
|
||||
|
||||
private Profiles profiles;
|
||||
|
||||
@Override
|
||||
public void onPropertySourceAdded(PropertySource<?> propertySource, ConfigDataLocation location,
|
||||
ConfigDataResource resource) {
|
||||
this.addedPropertySources.add(new AddedPropertySource(propertySource, location, resource));
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onSetProfiles(Profiles profiles) {
|
||||
this.profiles = profiles;
|
||||
}
|
||||
|
||||
List<AddedPropertySource> getAddedPropertySources() {
|
||||
return Collections.unmodifiableList(this.addedPropertySources);
|
||||
}
|
||||
|
||||
Profiles getProfiles() {
|
||||
return this.profiles;
|
||||
}
|
||||
|
||||
static class AddedPropertySource {
|
||||
|
||||
private final PropertySource<?> propertySource;
|
||||
|
||||
private final ConfigDataLocation location;
|
||||
|
||||
private final ConfigDataResource resource;
|
||||
|
||||
AddedPropertySource(PropertySource<?> propertySource, ConfigDataLocation location,
|
||||
ConfigDataResource resource) {
|
||||
this.propertySource = propertySource;
|
||||
this.location = location;
|
||||
this.resource = resource;
|
||||
}
|
||||
|
||||
PropertySource<?> getPropertySource() {
|
||||
return this.propertySource;
|
||||
}
|
||||
|
||||
ConfigDataLocation getLocation() {
|
||||
return this.location;
|
||||
}
|
||||
|
||||
ConfigDataResource getResource() {
|
||||
return this.resource;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
spring=boot
|
||||
@ -0,0 +1 @@
|
||||
spring.profiles.active=one,two,three
|
||||
Loading…
Reference in New Issue