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 static org.oransc.policyagent.repository.Ric.RicState;
25 import java.util.Vector;
27 import org.oransc.policyagent.clients.A1Client;
28 import org.oransc.policyagent.clients.A1ClientFactory;
29 import org.oransc.policyagent.clients.AsyncRestClient;
30 import org.oransc.policyagent.repository.ImmutablePolicyType;
31 import org.oransc.policyagent.repository.Lock;
32 import org.oransc.policyagent.repository.Lock.LockType;
33 import org.oransc.policyagent.repository.Policies;
34 import org.oransc.policyagent.repository.Policy;
35 import org.oransc.policyagent.repository.PolicyType;
36 import org.oransc.policyagent.repository.PolicyTypes;
37 import org.oransc.policyagent.repository.Ric;
38 import org.oransc.policyagent.repository.Service;
39 import org.oransc.policyagent.repository.Services;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
43 import reactor.core.publisher.Flux;
44 import reactor.core.publisher.Mono;
47 * Synchronizes the content of a RIC with the content in the repository. This
50 * load all policy types
52 * send all policy instances to the 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);
63 private final A1ClientFactory a1ClientFactory;
64 private final PolicyTypes policyTypes;
65 private final Policies policies;
66 private final Services services;
68 public RicSynchronizationTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies,
70 this.a1ClientFactory = a1ClientFactory;
71 this.policyTypes = policyTypes;
72 this.policies = policies;
73 this.services = services;
76 @SuppressWarnings("squid:S2445") // Blocks should be synchronized on "private final" fields
77 public void run(Ric ric) {
78 logger.debug("Handling ric: {}", ric.getConfig().name());
81 if (ric.getState() == RicState.SYNCHRONIZING) {
82 logger.debug("Ric: {} is already being synchronized", ric.getConfig().name());
85 ric.setState(RicState.SYNCHRONIZING);
88 ric.getLock().lock(LockType.EXCLUSIVE) // Make sure no NBI updates are running
89 .flatMap(Lock::unlock) //
90 .flatMap(lock -> this.a1ClientFactory.createA1Client(ric)) //
91 .flatMapMany(client -> startSynchronization(ric, client)) //
92 .subscribe(x -> logger.debug("Synchronize: {}", x), //
93 throwable -> onSynchronizationError(ric, throwable), //
94 () -> onSynchronizationComplete(ric));
97 private Flux<Object> startSynchronization(Ric ric, A1Client a1Client) {
98 Flux<PolicyType> recoverTypes = synchronizePolicyTypes(ric, a1Client);
99 Flux<?> policiesDeletedInRic = a1Client.deleteAllPolicies();
100 Flux<?> policiesRecreatedInRic = recreateAllPoliciesInRic(ric, a1Client);
102 return Flux.concat(recoverTypes, policiesDeletedInRic, policiesRecreatedInRic);
105 private void onSynchronizationComplete(Ric ric) {
106 logger.info("Synchronization completed for: {}", ric.name());
107 ric.setState(RicState.IDLE);
108 notifyAllServices("Synchronization completed for:" + ric.name());
111 private void notifyAllServices(String body) {
112 synchronized (services) {
113 for (Service service : services.getAll()) {
114 String url = service.getCallbackUrl();
115 if (service.getCallbackUrl().length() > 0) {
116 createNotificationClient(url) //
119 notUsed -> logger.debug("Service {} notified", service.getName()), throwable -> logger
120 .warn("Service notification failed for service: {}", service.getName(), throwable),
121 () -> logger.debug("All services notified"));
127 private void onSynchronizationError(Ric ric, Throwable t) {
128 logger.warn("Synchronization failed for ric: {}, reason: {}", ric.name(), t.getMessage());
129 // If synchronization fails, try to remove all instances
130 deleteAllPoliciesInRepository(ric);
132 Flux<PolicyType> recoverTypes = this.a1ClientFactory.createA1Client(ric) //
133 .flatMapMany(a1Client -> synchronizePolicyTypes(ric, a1Client));
134 Flux<?> deletePoliciesInRic = this.a1ClientFactory.createA1Client(ric) //
135 .flatMapMany(A1Client::deleteAllPolicies) //
136 .doOnComplete(() -> deleteAllPoliciesInRepository(ric));
138 Flux.concat(recoverTypes, deletePoliciesInRic) //
139 .subscribe(x -> logger.debug("Brute recover: {}", x), //
140 throwable -> onRecoveryError(ric, throwable), //
141 () -> onSynchronizationComplete(ric));
144 private void onRecoveryError(Ric ric, Throwable t) {
145 logger.warn("Synchronization failure recovery failed for ric: {}, reason: {}", ric.name(), t.getMessage());
146 ric.setState(RicState.UNDEFINED);
149 AsyncRestClient createNotificationClient(final String url) {
150 return new AsyncRestClient(url);
153 private Flux<PolicyType> synchronizePolicyTypes(Ric ric, A1Client a1Client) {
154 return a1Client.getPolicyTypeIdentities() //
155 .doOnNext(x -> ric.clearSupportedPolicyTypes()) //
156 .flatMapMany(Flux::fromIterable) //
157 .doOnNext(typeId -> logger.debug("For ric: {}, handling type: {}", ric.getConfig().name(), typeId)) //
158 .flatMap(policyTypeId -> getPolicyType(policyTypeId, a1Client)) //
159 .doOnNext(ric::addSupportedPolicyType); //
162 private Mono<PolicyType> getPolicyType(String policyTypeId, A1Client a1Client) {
163 if (policyTypes.contains(policyTypeId)) {
164 return Mono.just(policyTypes.get(policyTypeId));
166 return a1Client.getPolicyTypeSchema(policyTypeId) //
167 .flatMap(schema -> createPolicyType(policyTypeId, schema));
170 private Mono<PolicyType> createPolicyType(String policyTypeId, String schema) {
171 PolicyType pt = ImmutablePolicyType.builder().name(policyTypeId).schema(schema).build();
173 return Mono.just(pt);
176 private void deleteAllPoliciesInRepository(Ric ric) {
177 synchronized (policies) {
178 for (Policy policy : policies.getForRic(ric.name())) {
179 this.policies.remove(policy);
184 private Flux<String> recreateAllPoliciesInRic(Ric ric, A1Client a1Client) {
185 synchronized (policies) {
186 return Flux.fromIterable(new Vector<>(policies.getForRic(ric.name()))) //
188 policy -> logger.debug("Recreating policy: {}, for ric: {}", policy.id(), ric.getConfig().name()))
189 .flatMap(a1Client::putPolicy);