2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 Nordix Foundation
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ========================LICENSE_END===================================
21 package org.oransc.policyagent.tasks;
23 import com.google.gson.GsonBuilder;
24 import com.google.gson.JsonElement;
25 import com.google.gson.JsonObject;
26 import com.google.gson.JsonParser;
27 import com.google.gson.JsonSyntaxException;
28 import com.google.gson.TypeAdapterFactory;
30 import java.io.BufferedInputStream;
32 import java.io.FileInputStream;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.io.InputStreamReader;
36 import java.time.Duration;
37 import java.util.Properties;
38 import java.util.ServiceLoader;
40 import javax.validation.constraints.NotNull;
42 import lombok.AccessLevel;
45 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
46 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClientFactory;
47 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests;
48 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest;
49 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
50 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
51 import org.oransc.policyagent.clients.A1ClientFactory;
52 import org.oransc.policyagent.configuration.ApplicationConfig;
53 import org.oransc.policyagent.configuration.ApplicationConfig.RicConfigUpdate;
54 import org.oransc.policyagent.configuration.ApplicationConfigParser;
55 import org.oransc.policyagent.configuration.RicConfig;
56 import org.oransc.policyagent.exceptions.ServiceException;
57 import org.oransc.policyagent.repository.Policies;
58 import org.oransc.policyagent.repository.PolicyTypes;
59 import org.oransc.policyagent.repository.Ric;
60 import org.oransc.policyagent.repository.Rics;
61 import org.oransc.policyagent.repository.Services;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
64 import org.springframework.beans.factory.annotation.Autowired;
65 import org.springframework.beans.factory.annotation.Value;
66 import org.springframework.stereotype.Component;
68 import reactor.core.Disposable;
69 import reactor.core.publisher.Flux;
70 import reactor.core.publisher.Mono;
73 * Regularly refreshes the configuration from Consul or from a local
77 public class RefreshConfigTask {
79 private static final Logger logger = LoggerFactory.getLogger(RefreshConfigTask.class);
81 @Value("#{systemEnvironment}")
82 public Properties systemEnvironment;
84 final ApplicationConfig appConfig;
85 @Getter(AccessLevel.PROTECTED)
86 private Disposable refreshTask = null;
87 private boolean isConsulUsed = false;
89 private final Rics rics;
90 private final A1ClientFactory a1ClientFactory;
91 private final Policies policies;
92 private final Services services;
93 private final PolicyTypes policyTypes;
94 private static final Duration FILE_CONFIG_REFRESH_INTERVAL = Duration.ofMinutes(1);
95 private static final Duration CONSUL_CONFIG_REFRESH_INTERVAL = Duration.ofMinutes(1);
98 public RefreshConfigTask(ApplicationConfig appConfig, Rics rics, Policies policies, Services services,
99 PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) {
100 this.appConfig = appConfig;
102 this.policies = policies;
103 this.services = services;
104 this.policyTypes = policyTypes;
105 this.a1ClientFactory = a1ClientFactory;
108 public void start() {
109 logger.debug("Starting refreshConfigTask");
111 refreshTask = createRefreshTask() //
112 .subscribe(notUsed -> logger.debug("Refreshed configuration data"),
113 throwable -> logger.error("Configuration refresh terminated due to exception", throwable),
114 () -> logger.error("Configuration refresh terminated"));
118 if (refreshTask != null) {
119 refreshTask.dispose();
123 Flux<RicConfigUpdate.Type> createRefreshTask() {
124 Flux<JsonObject> loadFromFile = Flux.interval(Duration.ZERO, FILE_CONFIG_REFRESH_INTERVAL) //
125 .filter(notUsed -> configFileExists()) //
126 .filter(notUsed -> !this.isConsulUsed) //
127 .flatMap(notUsed -> loadConfigurationFromFile()) //
128 .onErrorResume(this::ignoreError) //
129 .doOnNext(json -> logger.debug("loadFromFile")) //
130 .doOnTerminate(() -> logger.error("loadFromFile Terminate"));
132 Flux<JsonObject> loadFromConsul = getEnvironment(systemEnvironment) //
133 .flatMap(this::createCbsClient) //
134 .flatMapMany(this::periodicConfigurationUpdates) //
135 .onErrorResume(this::ignoreError) //
136 .doOnNext(json -> logger.debug("loadFromConsul")) //
137 .doOnNext(json -> this.isConsulUsed = true) //
138 .doOnTerminate(() -> logger.error("loadFromConsul Terminate"));
140 return Flux.merge(loadFromFile, loadFromConsul) //
141 .flatMap(this::parseConfiguration) //
142 .flatMap(this::updateConfig) //
143 .doOnNext(this::handleUpdatedRicConfig) //
144 .flatMap(configUpdate -> Flux.just(configUpdate.getType())) //
145 .doOnTerminate(() -> logger.error("Configuration refresh task is terminated"));
148 Mono<EnvProperties> getEnvironment(Properties systemEnvironment) {
149 return EnvironmentProcessor.readEnvironmentVariables(systemEnvironment);
152 Mono<CbsClient> createCbsClient(EnvProperties env) {
153 return CbsClientFactory.createCbsClient(env);
156 private Flux<JsonObject> periodicConfigurationUpdates(CbsClient cbsClient) {
157 final Duration initialDelay = Duration.ZERO;
158 final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create());
159 return cbsClient.updates(getConfigRequest, initialDelay, CONSUL_CONFIG_REFRESH_INTERVAL);
162 private <R> Mono<R> ignoreError(Throwable throwable) {
163 String errMsg = throwable.toString();
164 logger.warn("Could not refresh application configuration. {}", errMsg);
168 private Mono<ApplicationConfigParser.ConfigParserResult> parseConfiguration(JsonObject jsonObject) {
170 ApplicationConfigParser parser = new ApplicationConfigParser();
171 return Mono.just(parser.parse(jsonObject));
172 } catch (ServiceException e) {
173 logger.error("Could not parse configuration {}", e.toString(), e);
174 return Mono.error(e);
178 private Flux<RicConfigUpdate> updateConfig(ApplicationConfigParser.ConfigParserResult config) {
179 return this.appConfig.setConfiguration(config);
182 boolean configFileExists() {
183 String filepath = appConfig.getLocalConfigurationFilePath();
184 return (filepath != null && (new File(filepath).exists()));
187 private void handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
188 synchronized (this.rics) {
189 String ricName = updatedInfo.getRicConfig().name();
190 RicConfigUpdate.Type event = updatedInfo.getType();
191 if (event == RicConfigUpdate.Type.ADDED) {
192 addRic(updatedInfo.getRicConfig());
193 } else if (event == RicConfigUpdate.Type.REMOVED) {
194 rics.remove(ricName);
195 this.policies.removePoliciesForRic(ricName);
196 } else if (event == RicConfigUpdate.Type.CHANGED) {
197 Ric ric = this.rics.get(ricName);
199 // Should not happen,just for robustness
200 addRic(updatedInfo.getRicConfig());
202 ric.setRicConfig(updatedInfo.getRicConfig());
208 private void addRic(RicConfig config) {
209 Ric ric = new Ric(config);
211 runRicSynchronization(ric);
214 void runRicSynchronization(Ric ric) {
215 RicSynchronizationTask synchronizationTask =
216 new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services);
217 synchronizationTask.run(ric);
221 * Reads the configuration from file.
223 Flux<JsonObject> loadConfigurationFromFile() {
224 String filepath = appConfig.getLocalConfigurationFilePath();
225 GsonBuilder gsonBuilder = new GsonBuilder();
226 ServiceLoader.load(TypeAdapterFactory.class).forEach(gsonBuilder::registerTypeAdapterFactory);
228 try (InputStream inputStream = createInputStream(filepath)) {
229 JsonObject rootObject = getJsonElement(inputStream).getAsJsonObject();
230 ApplicationConfigParser appParser = new ApplicationConfigParser();
231 appParser.parse(rootObject);
232 logger.debug("Local configuration file loaded: {}", filepath);
233 return Flux.just(rootObject);
234 } catch (JsonSyntaxException | ServiceException | IOException e) {
235 logger.debug("Local configuration file not loaded: {}", filepath, e);
240 JsonElement getJsonElement(InputStream inputStream) {
241 return JsonParser.parseReader(new InputStreamReader(inputStream));
244 InputStream createInputStream(@NotNull String filepath) throws IOException {
245 return new BufferedInputStream(new FileInputStream(filepath));