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=84818304671cd73fd4fa995dc23101a8cc1345eb;hb=6a39814272307d0207222c9229b0d765ac062bf0;hp=012d40a935540be9936b0d62ecce7feffab9dea5;hpb=7dc42f177188d1e56da95d366d94a65d37b0cec6;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 012d40a9..84818304 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,13 +23,17 @@ 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.ApiParam; import io.swagger.annotations.ApiResponse; import io.swagger.annotations.ApiResponses; +import java.net.MalformedURLException; +import java.net.URL; import java.time.Duration; +import java.util.ArrayList; import java.util.Collection; -import java.util.Vector; import org.oransc.policyagent.exceptions.ServiceException; import org.oransc.policyagent.repository.Policies; @@ -41,20 +45,19 @@ 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 @@ -66,90 +69,116 @@ public class ServiceController { @GetMapping("/services") @ApiOperation(value = "Returns service information") @ApiResponses( - value = {@ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List")}) - public ResponseEntity getServices( // + 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(// + @ApiParam(name = "name", required = false, value = "The name of the service") // @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 Vector<>(); - synchronized (this.services) { - for (Service s : this.services.getAll()) { - if (name == null || name.equals(s.getName())) { - servicesStatus.add(toServiceStatus(s)); - } + Collection servicesStatus = new ArrayList<>(); + 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); + return new ResponseEntity<>(res, HttpStatus.OK); } 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, MalformedURLException { + 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"); + } + if (!registrationInfo.callbackUrl.isEmpty()) { + new URL(registrationInfo.callbackUrl); + } } @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( // + 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 name) { + public ResponseEntity deleteService(// + @ApiParam(name = "name", required = true, value = "The name of the service") // + @RequestParam(name = "name", required = true) String serviceName) { try { - Service service = removeService(name); + 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); + 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 name) { + @PutMapping("/services/keepalive") + public ResponseEntity keepAliveService(// + @ApiParam(name = "name", required = true, value = "The name of the service") // + @RequestParam(name = "name", required = true) String serviceName) { try { - services.getService(name).ping(); - return new ResponseEntity("OK", HttpStatus.OK); - } catch (Exception e) { - return new ResponseEntity(e.getMessage(), HttpStatus.NOT_FOUND); + services.getService(serviceName).keepAlive(); + return new ResponseEntity<>("OK", HttpStatus.OK); + } 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) { - Vector policyList = new Vector<>(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); } } private Service toService(ServiceRegistrationInfo s) { - return new Service(s.name, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl); + return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl); } }