-
Notifications
You must be signed in to change notification settings - Fork 1k
common code for locate methods #2048
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
88 changes: 88 additions & 0 deletions
88
...java/org/springframework/cloud/kubernetes/commons/config/CommonPropertySourceLocator.java
This file contains hidden or 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,88 @@ | ||
| /* | ||
| * Copyright 2013-present 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.cloud.kubernetes.commons.config; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.LinkedHashSet; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Set; | ||
|
|
||
| import org.apache.commons.logging.LogFactory; | ||
|
|
||
| import org.springframework.cloud.bootstrap.config.PropertySourceLocator; | ||
| import org.springframework.core.env.CompositePropertySource; | ||
| import org.springframework.core.env.ConfigurableEnvironment; | ||
| import org.springframework.core.env.Environment; | ||
| import org.springframework.core.env.MapPropertySource; | ||
| import org.springframework.core.env.PropertySource; | ||
| import org.springframework.core.log.LogAccessor; | ||
|
|
||
| /** | ||
| * @author wind57 | ||
| */ | ||
| abstract class CommonPropertySourceLocator implements PropertySourceLocator { | ||
|
|
||
| private static final LogAccessor LOG = new LogAccessor(LogFactory.getLog(CommonPropertySourceLocator.class)); | ||
|
|
||
| protected final SourceConfigProperties properties; | ||
|
|
||
| private final SourceType sourceType; | ||
|
|
||
| CommonPropertySourceLocator(SourceConfigProperties properties, SourceType sourceType) { | ||
| this.properties = properties; | ||
| this.sourceType = sourceType; | ||
| } | ||
|
|
||
| protected abstract MapPropertySource getPropertySource(ConfigurableEnvironment environment, | ||
| NormalizedSource normalizedSource, ReadType readType); | ||
|
|
||
| @Override | ||
| public PropertySource<?> locate(Environment environment) { | ||
|
|
||
| if (environment instanceof ConfigurableEnvironment env) { | ||
|
|
||
| List<NormalizedSource> sources = properties.determineSources(sourceType, environment); | ||
| Set<NormalizedSource> uniqueSources = new LinkedHashSet<>(sources); | ||
| LOG.debug(sourceType.name() + " normalized sources : " + uniqueSources); | ||
| CompositePropertySource composite = new CompositePropertySource( | ||
| "composite-" + sourceType.name().toLowerCase(Locale.ROOT)); | ||
|
|
||
| uniqueSources.forEach(secretSource -> { | ||
| MapPropertySource propertySource = getPropertySource(env, secretSource, properties.readType()); | ||
|
|
||
| if ("true".equals(propertySource.getProperty(Constants.ERROR_PROPERTY))) { | ||
| LOG.warn(() -> "Failed to load source: " + secretSource); | ||
| } | ||
| else { | ||
| LOG.debug("Adding " + sourceType.name().toLowerCase(Locale.ROOT) + " property source " | ||
| + propertySource.getName()); | ||
| composite.addFirstPropertySource(propertySource); | ||
| } | ||
| }); | ||
|
|
||
| return composite; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<PropertySource<?>> locateCollection(Environment environment) { | ||
| return PropertySourceLocator.super.locateCollection(environment); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
31 changes: 31 additions & 0 deletions
31
...commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/SourceType.java
This file contains hidden or 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,31 @@ | ||
| /* | ||
| * Copyright 2013-present 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.cloud.kubernetes.commons.config; | ||
|
|
||
| public enum SourceType { | ||
|
|
||
| /** | ||
| * ConfigMap as the source type. | ||
| */ | ||
| CONFIGMAP, | ||
|
|
||
| /** | ||
| * Secret as the source type. | ||
| */ | ||
| SECRET | ||
|
|
||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we do the same code in
SecretsPropertySourceLocator::locateandConfigMapPropertySourceLocator::locate. As such, I created a common class that these two extend.