2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 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.clients;
23 import org.oransc.policyagent.clients.A1Client.A1ProtocolType;
24 import org.oransc.policyagent.configuration.ApplicationConfig;
25 import org.oransc.policyagent.configuration.ControllerConfig;
26 import org.oransc.policyagent.exceptions.ServiceException;
27 import org.oransc.policyagent.repository.Ric;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import org.springframework.beans.factory.annotation.Autowired;
31 import reactor.core.publisher.Mono;
34 * Factory for A1 clients that supports four different protocol versions of the
37 public class A1ClientFactory {
39 private static final Logger logger = LoggerFactory.getLogger(A1ClientFactory.class);
41 private final ApplicationConfig appConfig;
44 public A1ClientFactory(ApplicationConfig appConfig) {
45 this.appConfig = appConfig;
49 * Creates an A1 client with the correct A1 protocol for the provided Ric.
52 * It detects the protocol version by trial and error, since there is no
53 * getVersion method specified in the A1 api yet.
56 * As a side effect it also sets the protocol version in the provided Ric. This
57 * means that after the first successful creation it won't have to try which
58 * protocol to use, but can create the client directly.
60 * @param ric The RIC to get a client for.
61 * @return a client with the correct protocol, or a ServiceException if none of
62 * the protocols are supported by the Ric.
64 public Mono<A1Client> createA1Client(Ric ric) {
65 return getProtocolVersion(ric) //
66 .flatMap(version -> createA1ClientMono(ric, version));
69 A1Client createClient(Ric ric, A1ProtocolType version) throws ServiceException {
70 if (version == A1ProtocolType.STD_V1_1) {
71 assertNoControllerConfig(ric, version);
72 return new StdA1ClientVersion1(ric.getConfig());
73 } else if (version == A1ProtocolType.OSC_V1) {
74 assertNoControllerConfig(ric, version);
75 return new OscA1Client(ric.getConfig());
76 } else if (version == A1ProtocolType.SDNC_OSC_STD_V1_1 || version == A1ProtocolType.SDNC_OSC_OSC_V1) {
77 return new SdncOscA1Client(version, ric.getConfig(), getControllerConfig(ric));
78 } else if (version == A1ProtocolType.SDNC_ONAP) {
79 return new SdncOnapA1Client(ric.getConfig(), getControllerConfig(ric));
81 logger.error("Unhandled protocol: {}", version);
82 throw new ServiceException("Unhandled protocol");
86 private ControllerConfig getControllerConfig(Ric ric) throws ServiceException {
87 String controllerName = ric.getConfig().controllerName();
88 if (controllerName.isEmpty()) {
89 throw new ServiceException("No controller configured for RIC: " + ric.name());
91 return this.appConfig.getControllerConfig(controllerName);
94 private void assertNoControllerConfig(Ric ric, A1ProtocolType version) throws ServiceException {
95 if (!ric.getConfig().controllerName().isEmpty()) {
96 throw new ServiceException(
97 "Controller config should be empty, ric: " + ric.name() + " when using protocol version: " + version);
101 private Mono<A1Client> createA1ClientMono(Ric ric, A1ProtocolType version) {
103 return Mono.just(createClient(ric, version));
104 } catch (ServiceException e) {
105 return Mono.error(e);
109 private Mono<A1Client.A1ProtocolType> getProtocolVersion(Ric ric) {
110 if (ric.getProtocolVersion() == A1ProtocolType.UNKNOWN) {
111 return fetchVersion(ric, A1ProtocolType.STD_V1_1) //
112 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.OSC_V1)) //
113 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.SDNC_OSC_STD_V1_1)) //
114 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.SDNC_ONAP)) //
115 .doOnNext(ric::setProtocolVersion)
116 .doOnNext(version -> logger.debug("Established protocol version:{} for Ric: {}", version, ric.name())) //
117 .doOnError(notUsed -> logger.warn("Could not get protocol version from RIC: {}", ric.name())) //
119 notUsed -> Mono.error(new ServiceException("Protocol negotiation failed for " + ric.name())));
121 return Mono.just(ric.getProtocolVersion());
125 private Mono<A1ProtocolType> fetchVersion(Ric ric, A1ProtocolType protocolType) {
126 return createA1ClientMono(ric, protocolType) //
127 .flatMap(A1Client::getProtocolVersion);