2 * ================================================================================
3 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 * ============LICENSE_END=========================================================
20 package org.onap.dcae.analytics.web.spring;
22 import java.time.Duration;
23 import java.util.Arrays;
24 import java.util.Collections;
26 import java.util.Optional;
28 import java.util.stream.Collectors;
30 import org.onap.dcae.analytics.model.AnalyticsProfile;
31 import org.onap.dcae.analytics.model.configbindingservice.ConfigBindingServiceConstants;
32 import org.onap.dcae.analytics.model.util.function.JsonStringToMapFunction;
33 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
34 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClientFactory;
35 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests;
36 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsClientConfiguration;
37 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest;
38 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41 import org.springframework.boot.SpringApplication;
42 import org.springframework.boot.env.EnvironmentPostProcessor;
43 import org.springframework.core.Ordered;
44 import org.springframework.core.env.ConfigurableEnvironment;
45 import org.springframework.core.env.MapPropertySource;
46 import org.springframework.core.env.MutablePropertySources;
47 import org.springframework.core.env.PropertySource;
48 import org.springframework.core.env.StandardEnvironment;
49 import org.springframework.util.ClassUtils;
50 import org.springframework.web.context.support.StandardServletEnvironment;
52 import com.google.gson.JsonElement;
53 import com.google.gson.JsonObject;
55 import reactor.core.Disposable;
56 import reactor.core.publisher.Flux;
57 import reactor.core.publisher.Mono;
60 * A custom spring framework environment post processor which can fetch and populate spring context with
61 * Config Binding Service application properties.
63 * Activated only when config binding service profile is active.
65 * @author Rajiv Singla
67 public class ConfigBindingServiceEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
69 private static final Logger logger = LoggerFactory.getLogger(ConfigBindingServiceEnvironmentPostProcessor.class);
70 private static final String SERVLET_ENVIRONMENT_CLASS =
71 "org.springframework.web.context.support.StandardServletEnvironment";
73 private static final int DEFAULT_ORDER = Ordered.HIGHEST_PRECEDENCE;
75 private Disposable refreshConfigTask = null;
77 private ConfigurableEnvironment env = null;
79 private Map<String, Object> filterKeyMap = null;
81 private String configServicePropertiesKey =
82 ConfigBindingServiceConstants.CONFIG_BINDING_SERVICE_PROPERTIES_KEY;
85 public void postProcessEnvironment(final ConfigurableEnvironment environment,
86 final SpringApplication application) {
88 final boolean isConfigServiceProfilePresent = Arrays.stream(environment.getActiveProfiles())
89 .anyMatch(p -> p.equalsIgnoreCase(AnalyticsProfile.CONFIG_BINDING_SERVICE_PROFILE_NAME));
91 if (!isConfigServiceProfilePresent) {
92 logger.info("Config Binding Service Profile is not active. "
93 + "Skipping Adding config binding service properties");
97 logger.info("Config Binding Service Profile is active. "
98 + "Application properties will be fetched from config binding service");
106 public int getOrder() {
107 return DEFAULT_ORDER;
110 public synchronized void addJsonPropertySource(final MutablePropertySources sources,
111 final PropertySource<?> source) {
112 final String name = findPropertySource(sources);
113 if (sources.contains(name)) {
114 sources.addBefore(name, source);
116 sources.addFirst(source);
120 private String findPropertySource(final MutablePropertySources sources) {
121 if (ClassUtils.isPresent(SERVLET_ENVIRONMENT_CLASS, null)
122 && sources.contains(StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME)) {
123 return StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME;
126 return StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME;
131 * Fetch the configuration.
134 public void initialize() {
137 refreshConfigTask = createRefreshTask() //
138 .subscribe(e -> logger.info("Refreshed configuration data"),
139 throwable -> logger.error("Configuration refresh terminated due to exception", throwable),
140 () -> logger.error("Configuration refresh terminated"));
144 * Fetch the configuration task from CBS.
147 private Flux<String> createRefreshTask() {
148 return readEnvironmentVariables() //
149 .flatMap(this::createCbsClient) //
150 .flatMapMany(this::periodicConfigurationUpdates) //
151 .map(this::parseTcaConfig) //
152 .onErrorResume(this::onErrorResume);
156 * periodicConfigurationUpdates.
158 * @param cbsClient cbsClient
159 * @return configuration refreshed
162 public Flux<JsonObject> periodicConfigurationUpdates(CbsClient cbsClient) {
163 final Duration initialDelay = Duration.ZERO;
164 final Duration refreshPeriod =
165 Duration.ofMinutes(ConfigBindingServiceConstants.CONFIG_SERVICE_REFRESHPERIOD);
166 final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create());
167 return cbsClient.updates(getConfigRequest, initialDelay, refreshPeriod);
172 * get environment variables.
174 * @return environment properties.
177 public Mono<CbsClientConfiguration> readEnvironmentVariables() {
178 logger.trace("Loading configuration from system environment variables");
179 CbsClientConfiguration cbsClientConfiguration = CbsClientConfiguration.fromEnvironment();
180 return Mono.just(cbsClientConfiguration);
184 * Stops the refreshing of the configuration.
188 if (refreshConfigTask != null) {
189 refreshConfigTask.dispose();
190 refreshConfigTask = null;
195 * periodicConfigurationUpdates.
197 * @param throwable throwable
201 private <R> Mono<R> onErrorResume(Throwable throwable) {
202 logger.error("Could not refresh application configuration {}", throwable.toString());
209 * @param cbsClientConfiguration cbs configuration
213 public Mono<CbsClient> createCbsClient(CbsClientConfiguration cbsClientConfiguration) {
214 return CbsClientFactory.createCbsClient(cbsClientConfiguration);
218 * Parse configuration.
220 * @param jsonObject the TCA service's configuration
224 public String parseTcaConfig(JsonObject jsonObject) {
226 JsonElement jsonConfig = jsonObject.get(ConfigBindingServiceConstants.CONFIG);
228 Optional<String> configServiceJsonOptional = Optional.of(jsonConfig.toString());
230 // convert fetch config binding service json string to Map of property key and
232 Map<String, Object> configPropertiesMap = configServiceJsonOptional
233 .map(new JsonStringToMapFunction(configServicePropertiesKey)).orElse(Collections.emptyMap());
235 if (configPropertiesMap.isEmpty()) {
237 logger.warn("No properties found in config binding service");
241 // remove config service key prefix on spring reserved property key prefixes
242 final Set<String> springKeyPrefixes =
243 ConfigBindingServiceConstants.getSpringReservedPropertiesKeyPrefixes();
244 final Set<String> springKeys = springKeyPrefixes.stream()
245 .map(springKeyPrefix -> configServicePropertiesKey + "." + springKeyPrefix)
246 .collect(Collectors.toSet());
248 filterKeyMap = configPropertiesMap.entrySet().stream()
249 .collect(Collectors.toMap((Map.Entry<String, Object> e) -> springKeys.stream()
250 .anyMatch(springKey -> e.getKey().startsWith(springKey))
251 ? e.getKey().substring(configServicePropertiesKey.toCharArray().length + 1)
253 Map.Entry::getValue));
255 filterKeyMap.forEach((key, value) -> logger
256 .info("Adding property from config service in spring context: {} -> {}", key, value));
257 MutablePropertySources sources = env.getPropertySources();
258 addJsonPropertySource(sources, new MapPropertySource(configServicePropertiesKey, filterKeyMap));
261 return configServiceJsonOptional.get();