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.ImmutablePolicyType;
30 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
31 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
32 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
33 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
34 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
35 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
36 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
37 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 import reactor.core.publisher.BaseSubscriber;
42 import reactor.core.publisher.Flux;
43 import reactor.core.publisher.Mono;
44 import reactor.core.publisher.SignalType;
47 * Synchronizes the content of a Near-RT RIC with the content in the repository.
50 * load all policy types
52 * send all policy instances to the Near-RT RIC
54 * if that fails remove all policy instances
56 * Notify subscribing services
58 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
59 public class RicSynchronizationTask {
61 private static final Logger logger = LoggerFactory.getLogger(RicSynchronizationTask.class);
62 static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
64 private final A1ClientFactory a1ClientFactory;
65 private final PolicyTypes policyTypes;
66 private final Policies policies;
67 private final Services services;
68 private final Rics rics;
69 private final AsyncRestClientFactory restClientFactory;
71 public RicSynchronizationTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies,
72 Services services, AsyncRestClientFactory restClientFactory, Rics rics) {
73 this.a1ClientFactory = a1ClientFactory;
74 this.policyTypes = policyTypes;
75 this.policies = policies;
76 this.services = services;
77 this.restClientFactory = restClientFactory;
81 public void run(Ric ric) {
82 logger.debug("Handling ric: {}", ric.getConfig().ricId());
84 if (ric.getState() == RicState.SYNCHRONIZING) {
85 logger.debug("Ric: {} is already being synchronized", ric.getConfig().ricId());
89 ric.getLock().lock(LockType.EXCLUSIVE) //
90 .flatMap(notUsed -> setRicState(ric)) //
91 .flatMap(lock -> this.a1ClientFactory.createA1Client(ric)) //
92 .flatMapMany(client -> runSynchronization(ric, client)) //
93 .onErrorResume(throwable -> deleteAllPolicyInstances(ric, throwable))
94 .subscribe(new BaseSubscriber<Object>() {
96 protected void hookOnError(Throwable throwable) {
97 logger.warn("Synchronization failure for ric: {}, reason: {}", ric.id(),
98 throwable.getMessage());
99 ric.setState(RicState.UNAVAILABLE);
103 protected void hookOnComplete() {
104 onSynchronizationComplete(ric);
108 protected void hookFinally(SignalType type) {
109 ric.getLock().unlockBlocking();
114 @SuppressWarnings("squid:S2445") // Blocks should be synchronized on "private final" fields
115 private Mono<Ric> setRicState(Ric ric) {
117 if (ric.getState() == RicState.SYNCHRONIZING) {
118 logger.debug("Ric: {} is already being synchronized", ric.getConfig().ricId());
121 ric.setState(RicState.SYNCHRONIZING);
122 return Mono.just(ric);
126 private Flux<Object> runSynchronization(Ric ric, A1Client a1Client) {
127 Flux<PolicyType> synchronizedTypes = synchronizePolicyTypes(ric, a1Client);
128 Flux<?> policiesDeletedInRic = a1Client.deleteAllPolicies();
129 Flux<Policy> policiesRecreatedInRic = recreateAllPoliciesInRic(ric, a1Client);
131 return Flux.concat(synchronizedTypes, policiesDeletedInRic, policiesRecreatedInRic);
134 private void onSynchronizationComplete(Ric ric) {
135 if (this.rics.get(ric.id()) == null) {
136 logger.debug("Policies removed in removed ric: {}", ric.id());
139 logger.debug("Synchronization completed for: {}", ric.id());
140 ric.setState(RicState.AVAILABLE);
144 private Flux<Object> deleteAllPolicyInstances(Ric ric, Throwable t) {
145 logger.debug("Recreation of policies failed for ric: {}, reason: {}", ric.id(), t.getMessage());
146 deleteAllPoliciesInRepository(ric);
148 Flux<PolicyType> synchronizedTypes = this.a1ClientFactory.createA1Client(ric) //
149 .flatMapMany(a1Client -> synchronizePolicyTypes(ric, a1Client));
150 Flux<?> deletePoliciesInRic = this.a1ClientFactory.createA1Client(ric) //
151 .flatMapMany(A1Client::deleteAllPolicies) //
152 .doOnComplete(() -> deleteAllPoliciesInRepository(ric));
154 return Flux.concat(synchronizedTypes, deletePoliciesInRic);
157 void notifyServices(Ric ric) {
158 ServiceCallbacks callbacks = new ServiceCallbacks(this.restClientFactory);
159 callbacks.notifyServicesRicSynchronized(ric, services);
162 private Flux<PolicyType> synchronizePolicyTypes(Ric ric, A1Client a1Client) {
163 return a1Client.getPolicyTypeIdentities() //
164 .doOnNext(x -> ric.clearSupportedPolicyTypes()) //
165 .flatMapMany(Flux::fromIterable) //
166 .doOnNext(typeId -> logger.debug("For ric: {}, handling type: {}", ric.getConfig().ricId(), typeId)) //
167 .flatMap(policyTypeId -> getPolicyType(policyTypeId, a1Client), CONCURRENCY_RIC) //
168 .doOnNext(ric::addSupportedPolicyType); //
171 private Mono<PolicyType> getPolicyType(String policyTypeId, A1Client a1Client) {
172 if (policyTypes.contains(policyTypeId)) {
173 return Mono.just(policyTypes.get(policyTypeId));
175 return a1Client.getPolicyTypeSchema(policyTypeId) //
176 .flatMap(schema -> createPolicyType(policyTypeId, schema));
179 private Mono<PolicyType> createPolicyType(String policyTypeId, String schema) {
180 PolicyType pt = ImmutablePolicyType.builder().id(policyTypeId).schema(schema).build();
182 return Mono.just(pt);
185 private void deleteAllPoliciesInRepository(Ric ric) {
186 for (Policy policy : policies.getForRic(ric.id())) {
187 this.policies.remove(policy);
191 private Flux<Policy> putPolicy(Policy policy, Ric ric, A1Client a1Client) {
192 logger.debug("Recreating policy: {}, for ric: {}", policy.id(), ric.getConfig().ricId());
193 return a1Client.putPolicy(policy) //
194 .flatMapMany(notUsed -> Flux.just(policy));
197 private boolean checkTransient(Policy policy) {
198 if (policy.isTransient()) {
199 this.policies.remove(policy);
201 return policy.isTransient();
204 private Flux<Policy> recreateAllPoliciesInRic(Ric ric, A1Client a1Client) {
205 return Flux.fromIterable(policies.getForRic(ric.id())) //
206 .filter(policy -> !checkTransient(policy)) //
207 .flatMap(policy -> putPolicy(policy, ric, a1Client), CONCURRENCY_RIC);