X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fpolicyagent%2Fcontrollers%2FServiceController.java;h=bf787427dc71cd7664e8ea40cf83a0f17e60484d;hb=6a5e9e710f27997073db0c78b574681aa18189aa;hp=464511f4da919b136b9a044c22e9516c38556735;hpb=7c297ddb425a52dae965adc6a83629a14421ea05;p=nonrtric.git diff --git a/policy-agent/src/main/java/org/oransc/policyagent/controllers/ServiceController.java b/policy-agent/src/main/java/org/oransc/policyagent/controllers/ServiceController.java index 464511f4..bf787427 100644 --- a/policy-agent/src/main/java/org/oransc/policyagent/controllers/ServiceController.java +++ b/policy-agent/src/main/java/org/oransc/policyagent/controllers/ServiceController.java @@ -23,6 +23,7 @@ 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; @@ -30,7 +31,6 @@ import io.swagger.annotations.ApiResponses; import java.time.Duration; import java.util.ArrayList; import java.util.Collection; -import java.util.List; import org.oransc.policyagent.exceptions.ServiceException; import org.oransc.policyagent.repository.Policies; @@ -49,13 +49,13 @@ 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 @@ -67,16 +67,20 @@ public class ServiceController { @GetMapping("/services") @ApiOperation(value = "Returns service information") @ApiResponses( - value = {@ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List")}) + value = { // + @ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List"), // + @ApiResponse(code = 404, message = "Service is not found", response = String.class)}) public ResponseEntity getServices(// @RequestParam(name = "name", required = false) String name) { + if (name != null && this.services.get(name) == null) { + return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND); + } + Collection servicesStatus = new ArrayList<>(); - synchronized (this.services) { - for (Service s : this.services.getAll()) { - if (name == null || name.equals(s.getName())) { - servicesStatus.add(toServiceStatus(s)); - } + for (Service s : this.services.getAll()) { + if (name == null || name.equals(s.getName())) { + servicesStatus.add(toServiceStatus(s)); } } @@ -85,24 +89,43 @@ public class ServiceController { } private ServiceStatus toServiceStatus(Service s) { - return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds()); + return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(), + s.getCallbackUrl()); + } + + private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo) throws ServiceException { + if (registrationInfo.serviceName.isEmpty()) { + throw new ServiceException("Missing mandatory parameter 'serviceName'"); + } + if (registrationInfo.keepAliveIntervalSeconds < 0) { + throw new ServiceException("Keepalive interval shoul be greater or equal to 0"); + } } @ApiOperation(value = "Register a service") - @ApiResponses(value = {@ApiResponse(code = 200, message = "OK", response = String.class)}) + @ApiResponses( + value = { // + @ApiResponse(code = 200, message = "Service updated", response = String.class), + @ApiResponse(code = 201, message = "Service created", response = String.class), // + @ApiResponse(code = 400, message = "The ServiceRegistrationInfo is not accepted", response = String.class)}) @PutMapping("/service") public ResponseEntity putService(// @RequestBody ServiceRegistrationInfo registrationInfo) { try { + validateRegistrationInfo(registrationInfo); + final boolean isCreate = this.services.get(registrationInfo.serviceName) == null; this.services.put(toService(registrationInfo)); - return new ResponseEntity<>("OK", HttpStatus.OK); + return new ResponseEntity<>("OK", isCreate ? HttpStatus.CREATED : HttpStatus.OK); } catch (Exception e) { - return new ResponseEntity<>(e.getMessage(), HttpStatus.NO_CONTENT); + return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST); } } @ApiOperation(value = "Delete a service") - @ApiResponses(value = {@ApiResponse(code = 200, message = "OK")}) + @ApiResponses( + value = { // + @ApiResponse(code = 204, message = "OK"), + @ApiResponse(code = 404, message = "Service not found", response = String.class)}) @DeleteMapping("/services") public ResponseEntity deleteService(// @RequestParam(name = "name", required = true) String serviceName) { @@ -113,39 +136,36 @@ public class ServiceController { removePolicies(service); return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT); } catch (Exception e) { - return new ResponseEntity<>(e.getMessage(), HttpStatus.NO_CONTENT); + return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND); } } - @ApiOperation(value = "Keep the poilicies alive for a service") + @ApiOperation(value = "Heartbeat from a serice") @ApiResponses( - value = {@ApiResponse(code = 200, message = "Policies timeout supervision refreshed"), + value = { // + @ApiResponse(code = 200, message = "Service supervision timer refreshed, OK"), @ApiResponse(code = 404, message = "The service is not found, needs re-registration")}) @PostMapping("/services/keepalive") public ResponseEntity keepAliveService(// @RequestParam(name = "name", required = true) String serviceName) { try { - services.getService(serviceName).ping(); + services.getService(serviceName).keepAlive(); return new ResponseEntity<>("OK", HttpStatus.OK); - } catch (Exception e) { + } catch (ServiceException e) { return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND); } } private Service removeService(String name) throws ServiceException { - synchronized (this.services) { - Service service = this.services.getService(name); - this.services.remove(service.getName()); - return service; - } + Service service = this.services.getService(name); // Just to verify that it exists + this.services.remove(service.getName()); + return service; } private void removePolicies(Service service) { - synchronized (this.policies) { - List policyList = new ArrayList<>(this.policies.getForService(service.getName())); - for (Policy policy : policyList) { - this.policies.remove(policy); - } + Collection policyList = this.policies.getForService(service.getName()); + for (Policy policy : policyList) { + this.policies.remove(policy); } }