REST error codes
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / controllers / ServiceController.java
index bda5e09..35348c7 100644 (file)
@@ -23,93 +23,150 @@ package org.oransc.policyagent.controllers;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+
 import java.time.Duration;
+import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Vector;
+import java.util.List;
 
 import org.oransc.policyagent.exceptions.ServiceException;
+import org.oransc.policyagent.repository.Policies;
+import org.oransc.policyagent.repository.Policy;
 import org.oransc.policyagent.repository.Service;
 import org.oransc.policyagent.repository.Services;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
+@Api(tags = "Service registry and supervision")
 public class ServiceController {
 
     private final Services services;
+    private final Policies policies;
+
     private static Gson gson = new GsonBuilder() //
         .serializeNulls() //
         .create(); //
 
     @Autowired
-    ServiceController(Services services) {
+    ServiceController(Services services, Policies policies) {
         this.services = services;
+        this.policies = policies;
     }
 
-    @GetMapping("/service")
-    public ResponseEntity<String> getService( //
-        @RequestParam(name = "name", required = true) String name) {
-        try {
-            Service s = services.getService(name);
-            String res = gson.toJson(toServiceStatus(s));
-            return new ResponseEntity<String>(res, HttpStatus.OK);
+    @GetMapping("/services")
+    @ApiOperation(value = "Returns service information")
+    @ApiResponses(
+        value = { //
+            @ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List"), //
+            @ApiResponse(code = 404, message = "Service is not found", response = String.class)})
+    public ResponseEntity<String> getServices(//
+        @RequestParam(name = "name", required = false) String name) {
 
-        } catch (ServiceException e) {
-            return new ResponseEntity<String>(e.getMessage(), HttpStatus.NO_CONTENT);
+        if (name != null && this.services.get(name) == null) {
+            return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND);
+        }
+
+        Collection<ServiceStatus> servicesStatus = new ArrayList<>();
+        synchronized (this.services) {
+            for (Service s : this.services.getAll()) {
+                if (name == null || name.equals(s.getName())) {
+                    servicesStatus.add(toServiceStatus(s));
+                }
+            }
         }
+
+        String res = gson.toJson(servicesStatus);
+        return new ResponseEntity<>(res, HttpStatus.OK);
     }
 
     private ServiceStatus toServiceStatus(Service s) {
-        return ImmutableServiceStatus.builder() //
-            .name(s.getName()) //
-            .keepAliveInterval(s.getKeepAliveInterval().toSeconds()) //
-            .timeSincePing(s.timeSinceLastPing().toSeconds()) //
-            .build();
+        return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(),
+            s.getCallbackUrl());
     }
 
+    @ApiOperation(value = "Register a service")
+    @ApiResponses(
+        value = { //
+            @ApiResponse(code = 200, message = "OK", response = String.class),
+            @ApiResponse(code = 400, message = "Cannot parse the ServiceRegistrationInfo", response = String.class)})
     @PutMapping("/service")
-    public ResponseEntity<String> putService( //
-        @RequestBody String jsonBody) {
+    public ResponseEntity<String> putService(//
+        @RequestBody ServiceRegistrationInfo registrationInfo) {
         try {
-            ServiceRegistrationInfo s = gson.fromJson(jsonBody, ImmutableServiceRegistrationInfo.class);
-            this.services.put(toService(s));
-            return new ResponseEntity<String>("OK", HttpStatus.OK);
+            this.services.put(toService(registrationInfo));
+            return new ResponseEntity<>("OK", HttpStatus.OK);
         } catch (Exception e) {
-            return new ResponseEntity<String>(e.getMessage(), HttpStatus.NO_CONTENT);
+            return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
         }
     }
 
-    private Service toService(ServiceRegistrationInfo s) {
-        return new Service(s.name(), Duration.ofSeconds(s.keepAliveInterval()), s.callbackUrl());
+    @ApiOperation(value = "Delete a service")
+    @ApiResponses(
+        value = { //
+            @ApiResponse(code = 204, message = "OK"),
+            @ApiResponse(code = 404, message = "Service not found", response = String.class)})
+    @DeleteMapping("/services")
+    public ResponseEntity<String> deleteService(//
+        @RequestParam(name = "name", required = true) String serviceName) {
+        try {
+            Service service = removeService(serviceName);
+            // Remove the policies from the repo and let the consistency monitoring
+            // do the rest.
+            removePolicies(service);
+            return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT);
+        } catch (Exception e) {
+            return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
+        }
     }
 
-    @GetMapping("/services")
-    public ResponseEntity<?> getServices() {
-        Collection<ServiceStatus> result = new Vector<>();
+    @ApiOperation(value = "Keep the policies alive for a service")
+    @ApiResponses(
+        value = { //
+            @ApiResponse(code = 200, message = "Policies timeout supervision refreshed"),
+            @ApiResponse(code = 404, message = "The service is not found, needs re-registration")})
+    @PostMapping("/services/keepalive")
+    public ResponseEntity<String> keepAliveService(//
+        @RequestParam(name = "name", required = true) String serviceName) {
+        try {
+            services.getService(serviceName).ping();
+            return new ResponseEntity<>("OK", HttpStatus.OK);
+        } catch (Exception e) {
+            return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
+        }
+    }
+
+    private Service removeService(String name) throws ServiceException {
         synchronized (this.services) {
-            for (Service s : this.services.getAll()) {
-                result.add(toServiceStatus(s));
-            }
+            Service service = this.services.getService(name);
+            this.services.remove(service.getName());
+            return service;
         }
-        return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
     }
 
-    @PutMapping("/service/ping")
-    public ResponseEntity<String> ping( //
-        @RequestBody String name) {
-        try {
-            Service s = services.getService(name);
-            s.ping();
-            return new ResponseEntity<String>("OK", HttpStatus.OK);
-        } catch (ServiceException e) {
-            return new ResponseEntity<String>(e.getMessage(), HttpStatus.NO_CONTENT);
+    private void removePolicies(Service service) {
+        synchronized (this.policies) {
+            List<Policy> policyList = new ArrayList<>(this.policies.getForService(service.getName()));
+            for (Policy policy : policyList) {
+                this.policies.remove(policy);
+            }
         }
     }
 
+    private Service toService(ServiceRegistrationInfo s) {
+        return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl);
+    }
+
 }