policy-agent/src/main/java/org/oransc/policyagent/controllers/ServiceController.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   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.oransc.policyagent.controllers;
  22
  23 import com.google.gson.Gson;
  24 import com.google.gson.GsonBuilder;
  25
  26 import io.swagger.annotations.Api;
  27 import io.swagger.annotations.ApiOperation;
  28 import io.swagger.annotations.ApiResponse;
  29 import io.swagger.annotations.ApiResponses;
  30
  31 import java.time.Duration;
  32 import java.util.ArrayList;
  33 import java.util.Collection;
  34
  35 import org.oransc.policyagent.exceptions.ServiceException;
  36 import org.oransc.policyagent.repository.Policies;
  37 import org.oransc.policyagent.repository.Policy;
  38 import org.oransc.policyagent.repository.Service;
  39 import org.oransc.policyagent.repository.Services;
  40 import org.springframework.beans.factory.annotation.Autowired;
  41 import org.springframework.http.HttpStatus;
  42 import org.springframework.http.ResponseEntity;
  43 import org.springframework.web.bind.annotation.DeleteMapping;
  44 import org.springframework.web.bind.annotation.GetMapping;
  45 import org.springframework.web.bind.annotation.PostMapping;
  46 import org.springframework.web.bind.annotation.PutMapping;
  47 import org.springframework.web.bind.annotation.RequestBody;
  48 import org.springframework.web.bind.annotation.RequestParam;
  49 import org.springframework.web.bind.annotation.RestController;
  50
  51 @RestController
  52 @Api(tags = "Service registry and supervision")
  53 public class ServiceController {
  54
  55     private final Services services;
  56     private final Policies policies;
  57
  58     private static Gson gson = new GsonBuilder() //
  59         .create(); //
  60
  61     @Autowired
  62     ServiceController(Services services, Policies policies) {
  63         this.services = services;
  64         this.policies = policies;
  65     }
  66
  67     @GetMapping("/services")
  68     @ApiOperation(value = "Returns service information")
  69     @ApiResponses(
  70         value = { //
  71             @ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List"), //
  72             @ApiResponse(code = 404, message = "Service is not found", response = String.class)})
  73     public ResponseEntity<String> getServices(//
  74         @RequestParam(name = "name", required = false) String name) {
  75
  76         if (name != null && this.services.get(name) == null) {
  77             return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND);
  78         }
  79
  80         Collection<ServiceStatus> servicesStatus = new ArrayList<>();
  81         for (Service s : this.services.getAll()) {
  82             if (name == null || name.equals(s.getName())) {
  83                 servicesStatus.add(toServiceStatus(s));
  84             }
  85         }
  86
  87         String res = gson.toJson(servicesStatus);
  88         return new ResponseEntity<>(res, HttpStatus.OK);
  89     }
  90
  91     private ServiceStatus toServiceStatus(Service s) {
  92         return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(),
  93             s.getCallbackUrl());
  94     }
  95
  96     private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo) throws ServiceException {
  97         if (registrationInfo.serviceName.isEmpty()) {
  98             throw new ServiceException("Missing mandatory parameter 'serviceName'");
  99         }
 100         if (registrationInfo.keepAliveIntervalSeconds < 0) {
 101             throw new ServiceException("Keepalive interval shoul be greater or equal to 0");
 102         }
 103     }
 104
 105     @ApiOperation(value = "Register a service")
 106     @ApiResponses(
 107         value = { //
 108             @ApiResponse(code = 200, message = "Service updated", response = String.class),
 109             @ApiResponse(code = 201, message = "Service created", response = String.class), //
 110             @ApiResponse(code = 400, message = "The ServiceRegistrationInfo is not accepted", response = String.class)})
 111     @PutMapping("/service")
 112     public ResponseEntity<String> putService(//
 113         @RequestBody ServiceRegistrationInfo registrationInfo) {
 114         try {
 115             validateRegistrationInfo(registrationInfo);
 116             final boolean isCreate = this.services.get(registrationInfo.serviceName) == null;
 117             this.services.put(toService(registrationInfo));
 118             return new ResponseEntity<>("OK", isCreate ? HttpStatus.CREATED : HttpStatus.OK);
 119         } catch (Exception e) {
 120             return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
 121         }
 122     }
 123
 124     @ApiOperation(value = "Delete a service")
 125     @ApiResponses(
 126         value = { //
 127             @ApiResponse(code = 204, message = "OK"),
 128             @ApiResponse(code = 404, message = "Service not found", response = String.class)})
 129     @DeleteMapping("/services")
 130     public ResponseEntity<String> deleteService(//
 131         @RequestParam(name = "name", required = true) String serviceName) {
 132         try {
 133             Service service = removeService(serviceName);
 134             // Remove the policies from the repo and let the consistency monitoring
 135             // do the rest.
 136             removePolicies(service);
 137             return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT);
 138         } catch (Exception e) {
 139             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
 140         }
 141     }
 142
 143     @ApiOperation(value = "Heartbeat from a serice")
 144     @ApiResponses(
 145         value = { //
 146             @ApiResponse(code = 200, message = "Service supervision timer refreshed, OK"),
 147             @ApiResponse(code = 404, message = "The service is not found, needs re-registration")})
 148     @PostMapping("/services/keepalive")
 149     public ResponseEntity<String> keepAliveService(//
 150         @RequestParam(name = "name", required = true) String serviceName) {
 151         try {
 152             services.getService(serviceName).keepAlive();
 153             return new ResponseEntity<>("OK", HttpStatus.OK);
 154         } catch (ServiceException e) {
 155             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
 156         }
 157     }
 158
 159     private Service removeService(String name) throws ServiceException {
 160         Service service = this.services.getService(name); // Just to verify that it exists
 161         this.services.remove(service.getName());
 162         return service;
 163     }
 164
 165     private void removePolicies(Service service) {
 166         Collection<Policy> policyList = this.policies.getForService(service.getName());
 167         for (Policy policy : policyList) {
 168             this.policies.remove(policy);
 169         }
 170     }
 171
 172     private Service toService(ServiceRegistrationInfo s) {
 173         return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl);
 174     }
 175
 176 }