gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-2023 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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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===================================
  19  */
  20
  21 package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
  22
  23 import io.swagger.v3.oas.annotations.tags.Tag;
  24 import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v2.ServiceRegistryAndSupervisionApi;
  25 import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
  26 import org.onap.ccsdk.oran.a1policymanagementservice.models.v2.ServiceRegistrationInfo;
  27 import org.onap.ccsdk.oran.a1policymanagementservice.models.v2.ServiceStatus;
  28 import org.onap.ccsdk.oran.a1policymanagementservice.models.v2.ServiceStatusList;
  29 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  30 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  31 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service;
  32 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35 import org.springframework.beans.factory.annotation.Autowired;
  36 import org.springframework.http.HttpStatus;
  37 import org.springframework.http.ResponseEntity;
  38 import org.springframework.web.bind.annotation.RestController;
  39 import org.springframework.web.server.ServerWebExchange;
  40
  41 import reactor.core.publisher.Mono;
  42
  43 import java.lang.invoke.MethodHandles;
  44 import java.net.MalformedURLException;
  45 import java.net.URL;
  46 import java.time.Duration;
  47 import java.util.ArrayList;
  48 import java.util.Collection;
  49 import java.util.List;
  50
  51 @RestController("ServiceControllerV2")
  52 @Tag( //
  53         name = ServiceController.API_NAME, //
  54         description = ServiceController.API_DESCRIPTION //
  55
  56 )
  57 public class ServiceController implements ServiceRegistryAndSupervisionApi {
  58
  59     public static final String API_NAME = "Service Registry and Supervision";
  60     public static final String API_DESCRIPTION = "";
  61
  62     private final Services services;
  63     private final Policies policies;
  64
  65     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  66
  67     @Autowired
  68     private PolicyController policyController;
  69
  70     ServiceController(Services services, Policies policies) {
  71         this.services = services;
  72         this.policies = policies;
  73     }
  74
  75     private static final String GET_SERVICE_DETAILS =
  76             "Either information about a registered service with given identity or all registered services are returned.";
  77
  78     @Override
  79     public Mono<ResponseEntity<ServiceStatusList>> getServices(final String name, final ServerWebExchange exchange) throws Exception {
  80         if (name != null && this.services.get(name) == null) {
  81             throw new ServiceException("Service not found", HttpStatus.NOT_FOUND);
  82         }
  83
  84         List<ServiceStatus> servicesStatus = new ArrayList<>();
  85         for (Service s : this.services.getAll()) {
  86             if (name == null || name.equals(s.getName())) {
  87                 servicesStatus.add(toServiceStatus(s));
  88             }
  89         }
  90         return Mono.just(new ResponseEntity<>(new ServiceStatusList().serviceList(servicesStatus), HttpStatus.OK));
  91     }
  92
  93     private ServiceStatus toServiceStatus(Service s) {
  94         return new ServiceStatus()
  95                 .serviceId(s.getName())
  96                 .keepAliveIntervalSeconds(s.getKeepAliveInterval().toSeconds())
  97                 .timeSinceLastActivitySeconds(s.timeSinceLastPing().toSeconds())
  98                 .callbackUrl(s.getCallbackUrl());
  99     }
 100
 101     private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo)
 102             throws ServiceException, MalformedURLException {
 103         if (registrationInfo.getServiceId().isEmpty()) {
 104             throw new ServiceException("Missing mandatory parameter 'service-id'");
 105         }
 106         if (registrationInfo.getKeepAliveIntervalSeconds() < 0) {
 107             throw new ServiceException("Keep alive interval should be greater or equal to 0");
 108         }
 109         if (!registrationInfo.getCallbackUrl().isEmpty()) {
 110             new URL(registrationInfo.getCallbackUrl());
 111         }
 112     }
 113
 114     private static final String REGISTER_SERVICE_DETAILS = "Registering a service is needed to:" //
 115             + "<ul>" //
 116             + "<li>Get callbacks about available NearRT RICs.</li>" //
 117             + "<li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li>"//
 118             + "</ul>" //
 119             + "Policies can be created even if the service is not registerred. This is a feature which it is optional to use.";
 120
 121     @Override
 122     public Mono<ResponseEntity<Object>> putService(final Mono<ServiceRegistrationInfo> registrationInfo, final ServerWebExchange exchange) {
 123         return registrationInfo.flatMap(info -> {
 124             try {
 125                 validateRegistrationInfo(info);
 126             } catch (Exception e) {
 127                 return ErrorResponse.createMono(e, HttpStatus.BAD_REQUEST);
 128             }
 129             final boolean isCreate = this.services.get(info.getServiceId()) == null;
 130             this.services.put(toService(info));
 131             return Mono.just(new ResponseEntity<>(isCreate ? HttpStatus.CREATED : HttpStatus.OK));
 132         }).onErrorResume(Exception.class, e -> ErrorResponse.createMono(e, HttpStatus.BAD_REQUEST));
 133     }
 134
 135     @Override
 136     public Mono<ResponseEntity<Object>> deleteService(final String serviceId, final ServerWebExchange exchange) {
 137         try {
 138             Service service = removeService(serviceId);
 139             removePolicies(service, exchange);
 140             return Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT));
 141         } catch (ServiceException | NullPointerException e) {
 142             logger.warn("Exception caught during service deletion while deleting service {}: {}", serviceId,
 143                     e.getMessage());
 144             return ErrorResponse.createMono(e, HttpStatus.NOT_FOUND);
 145         }
 146     }
 147
 148     @Override
 149     public Mono<ResponseEntity<Object>> keepAliveService(final String serviceId, final ServerWebExchange exchange) throws ServiceException {
 150         services.getService(serviceId).keepAlive();
 151         return Mono.just(new ResponseEntity<>(HttpStatus.OK));
 152     }
 153
 154     private Service removeService(String name) throws ServiceException {
 155         Service service = this.services.getService(name); // Just to verify that it exists
 156         logger.trace("Service name to be deleted: {}", service.getName());
 157         this.services.remove(service.getName());
 158         return service;
 159     }
 160
 161     private void removePolicies(Service service, ServerWebExchange exchange) {
 162         Collection<Policy> policyList = this.policies.getForService(service.getName());
 163         logger.trace("Policies to be deleted: {}", policyList);
 164         for (Policy policy : policyList) {
 165             try {
 166                 policyController.deletePolicy(policy.getId(), exchange).doOnNext(resp -> {
 167                     if (resp.getStatusCode().is2xxSuccessful()) {
 168                         logger.trace("Deleting Policy '{}' when deleting Service '{}'", policy.getId(),
 169                                 service.getName());
 170                     } else {
 171                         logger.warn("Possible problem deleting Policy '{}' when deleting Service '{}'. Continuing, "
 172                                 + "but might trigger a re-sync with affected ric '{}'. Repsonse: \"{}\"",
 173                                 policy.getId(), service.getName(), policy.getRic().getConfig().getRicId(),
 174                                 resp.toString());
 175                     }
 176                 }).subscribe();
 177             } catch (Exception e) {
 178                 logger.warn("Problem deleting Policy '{}' when deleting Service '{}'."
 179                         + " Continuing, but might trigger a re-sync with affected ric '{}'. Problem: \"{}\"",
 180                         policy.getId(), service.getName(), policy.getRic().getConfig().getRicId(), e.getMessage());
 181             }
 182         }
 183     }
 184
 185     private Service toService(ServiceRegistrationInfo s) {
 186         return new Service(s.getServiceId(), Duration.ofSeconds(s.getKeepAliveIntervalSeconds()), s.getCallbackUrl());
 187     }
 188
 189 }