2 * ========================LICENSE_START=================================
4 * ======================================================================
5 * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
6 * ======================================================================
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.onap.ccsdk.oran.a1policymanagementservice.tasks;
23 import static org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
25 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
26 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
27 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
28 import org.onap.ccsdk.oran.a1policymanagementservice.controllers.ServiceCallbacks;
29 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
30 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
31 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
32 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
33 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
34 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
35 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
36 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 import reactor.core.publisher.BaseSubscriber;
41 import reactor.core.publisher.Flux;
42 import reactor.core.publisher.Mono;
43 import reactor.core.publisher.SignalType;
46 * Synchronizes the content of a Near-RT RIC with the content in the repository.
49 * load all policy types
51 * send all policy instances to the Near-RT RIC
53 * if that fails remove all policy instances
55 * Notify subscribing services
57 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
58 public class RicSynchronizationTask {
60 private static final Logger logger = LoggerFactory.getLogger(RicSynchronizationTask.class);
61 static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
63 private final A1ClientFactory a1ClientFactory;
64 private final PolicyTypes policyTypes;
65 private final Policies policies;
66 private final Services services;
67 private final Rics rics;
68 private final AsyncRestClientFactory restClientFactory;
70 public RicSynchronizationTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies,
71 Services services, AsyncRestClientFactory restClientFactory, Rics rics) {
72 this.a1ClientFactory = a1ClientFactory;
73 this.policyTypes = policyTypes;
74 this.policies = policies;
75 this.services = services;
76 this.restClientFactory = restClientFactory;
80 public void run(Ric ric) {
81 logger.debug("Ric synchronization task created: {}", ric.getConfig().ricId());
83 if (ric.getState() == RicState.SYNCHRONIZING) {
84 logger.debug("Ric: {} is already being synchronized", ric.getConfig().ricId());
88 ric.getLock().lock(LockType.EXCLUSIVE, "RicSynchronizationTask") //
89 .flatMap(notUsed -> synchronizeRic(ric)) //
90 .subscribe(new BaseSubscriber<Object>() {
93 protected void hookFinally(SignalType type) {
94 ric.getLock().unlockBlocking();
99 public Mono<Ric> synchronizeRic(Ric ric) {
100 return setRicState(ric) //
101 .flatMap(lock -> this.a1ClientFactory.createA1Client(ric)) //
102 .flatMapMany(client -> runSynchronization(ric, client)) //
103 .onErrorResume(throwable -> deleteAllPolicyInstances(ric, throwable)) //
105 .map(notUsed -> ric) //
107 logger.warn("Synchronization failure for ric: {}, reason: {}", ric.id(), t.getMessage()); //
108 ric.setState(RicState.UNAVAILABLE); //
110 .flatMap(notUsed -> onSynchronizationComplete(ric)) //
111 .onErrorResume(t -> Mono.just(ric));
114 public Flux<PolicyType> synchronizePolicyTypes(Ric ric, A1Client a1Client) {
115 return a1Client.getPolicyTypeIdentities() //
116 .doOnNext(x -> ric.clearSupportedPolicyTypes()) //
117 .flatMapMany(Flux::fromIterable) //
118 .doOnNext(typeId -> logger.debug("For ric: {}, handling type: {}", ric.getConfig().ricId(), typeId)) //
119 .flatMap(policyTypeId -> getPolicyType(policyTypeId, a1Client), CONCURRENCY_RIC) //
120 .doOnNext(ric::addSupportedPolicyType); //
123 @SuppressWarnings("squid:S2445") // Blocks should be synchronized on "private final" fields
124 private Mono<Ric> setRicState(Ric ric) {
126 if (ric.getState() == RicState.SYNCHRONIZING) {
127 logger.debug("Ric: {} is already being synchronized", ric.getConfig().ricId());
130 logger.debug("Ric state set to SYNCHRONIZING: {}", ric.getConfig().ricId());
131 ric.setState(RicState.SYNCHRONIZING);
132 return Mono.just(ric);
136 private Flux<Object> runSynchronization(Ric ric, A1Client a1Client) {
137 Flux<PolicyType> synchronizedTypes = synchronizePolicyTypes(ric, a1Client);
138 Flux<?> policiesDeletedInRic = a1Client.deleteAllPolicies();
139 Flux<Policy> policiesRecreatedInRic = recreateAllPoliciesInRic(ric, a1Client);
141 return Flux.concat(synchronizedTypes, policiesDeletedInRic, policiesRecreatedInRic);
144 private Mono<Ric> onSynchronizationComplete(Ric ric) {
145 if (this.rics.get(ric.id()) == null) {
146 logger.debug("Policies removed in removed ric: {}", ric.id());
149 logger.debug("Synchronization completed for: {}", ric.id());
150 ric.setState(RicState.AVAILABLE);
151 ServiceCallbacks callbacks = new ServiceCallbacks(this.restClientFactory);
152 return callbacks.notifyServicesRicAvailable(ric, services) //
157 private Flux<Object> deleteAllPolicyInstances(Ric ric, Throwable t) {
158 logger.warn("Recreation of policies failed for ric: {}, reason: {}", ric.id(), t.getMessage());
159 deleteAllPoliciesInRepository(ric);
161 Flux<PolicyType> synchronizedTypes = this.a1ClientFactory.createA1Client(ric) //
162 .flatMapMany(a1Client -> synchronizePolicyTypes(ric, a1Client));
163 Flux<?> deletePoliciesInRic = this.a1ClientFactory.createA1Client(ric) //
164 .flatMapMany(A1Client::deleteAllPolicies) //
165 .doOnComplete(() -> deleteAllPoliciesInRepository(ric));
167 return Flux.concat(synchronizedTypes, deletePoliciesInRic);
170 private Mono<PolicyType> getPolicyType(String policyTypeId, A1Client a1Client) {
171 if (policyTypes.contains(policyTypeId)) {
172 return Mono.just(policyTypes.get(policyTypeId));
174 return a1Client.getPolicyTypeSchema(policyTypeId) //
175 .map(schema -> createPolicyType(policyTypeId, schema));
178 private PolicyType createPolicyType(String policyTypeId, String schema) {
179 PolicyType pt = PolicyType.builder().id(policyTypeId).schema(schema).build();
184 private void deleteAllPoliciesInRepository(Ric ric) {
185 for (Policy policy : policies.getForRic(ric.id())) {
186 this.policies.remove(policy);
190 private Flux<Policy> putPolicy(Policy policy, Ric ric, A1Client a1Client) {
191 logger.trace("Recreating policy: {}, for ric: {}", policy.getId(), ric.getConfig().ricId());
192 return a1Client.putPolicy(policy) //
193 .flatMapMany(notUsed -> Flux.just(policy));
196 private boolean checkTransient(Policy policy) {
197 if (policy.isTransient()) {
198 this.policies.remove(policy);
200 return policy.isTransient();
203 private Flux<Policy> recreateAllPoliciesInRic(Ric ric, A1Client a1Client) {
204 return Flux.fromIterable(policies.getForRic(ric.id())) //
205 .doOnNext(policy -> logger.debug("Recreating policy: {}, ric: {}", policy.getId(), ric.id())) //
206 .filter(policy -> !checkTransient(policy)) //
207 .flatMap(policy -> putPolicy(policy, ric, a1Client), CONCURRENCY_RIC)
208 .doOnError(t -> logger.warn("Recreating policy failed, ric: {}, reason: {}", ric.id(), t.getMessage()));