X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fpolicyagent%2Fcontrollers%2FPolicyController.java;h=0f3b391f2a372777d87e47951a4eb5528a51b649;hb=96805287db06a91e569c184cc34ba4e69e4d22b2;hp=12deb819918a61129fcdc83cdff823d5f7ae669a;hpb=f26d17f375a8ab4d521549543d4fcc36bdc98865;p=nonrtric.git diff --git a/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java b/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java index 12deb819..0f3b391f 100644 --- a/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java +++ b/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java @@ -28,19 +28,24 @@ import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiResponse; import io.swagger.annotations.ApiResponses; +import java.util.ArrayList; import java.util.Collection; -import java.util.Vector; +import java.util.List; + +import lombok.Getter; import org.oransc.policyagent.clients.A1ClientFactory; -import org.oransc.policyagent.configuration.ApplicationConfig; import org.oransc.policyagent.exceptions.ServiceException; import org.oransc.policyagent.repository.ImmutablePolicy; +import org.oransc.policyagent.repository.Lock.LockType; import org.oransc.policyagent.repository.Policies; import org.oransc.policyagent.repository.Policy; import org.oransc.policyagent.repository.PolicyType; import org.oransc.policyagent.repository.PolicyTypes; import org.oransc.policyagent.repository.Ric; import org.oransc.policyagent.repository.Rics; +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; @@ -50,46 +55,56 @@ 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; +import org.springframework.web.reactive.function.client.WebClientResponseException; import reactor.core.publisher.Mono; @RestController -@Api(value = "Policy Management API") +@Api(tags = "A1 Policy Management") public class PolicyController { - private final Rics rics; - private final PolicyTypes policyTypes; - private final Policies policies; - private final A1ClientFactory a1ClientFactory; + public static class RejectionException extends Exception { + private static final long serialVersionUID = 1L; + @Getter + private final HttpStatus status; + + public RejectionException(String message, HttpStatus status) { + super(message); + this.status = status; + } + } + + @Autowired + private Rics rics; + @Autowired + private PolicyTypes policyTypes; + @Autowired + private Policies policies; + @Autowired + private A1ClientFactory a1ClientFactory; + @Autowired + private Services services; private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // - @Autowired - PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, - A1ClientFactory a1ClientFactory) { - this.policyTypes = types; - this.policies = policies; - this.rics = rics; - this.a1ClientFactory = a1ClientFactory; - } - @GetMapping("/policy_schemas") @ApiOperation(value = "Returns policy type schema definitions") @ApiResponses( value = { - @ApiResponse(code = 200, message = "Policy schemas", response = String.class, responseContainer = "List")}) + @ApiResponse(code = 200, message = "Policy schemas", response = Object.class, responseContainer = "List"), // + @ApiResponse(code = 404, message = "RIC is not found", response = String.class)}) public ResponseEntity getPolicySchemas(@RequestParam(name = "ric", required = false) String ricName) { synchronized (this.policyTypes) { if (ricName == null) { Collection types = this.policyTypes.getAll(); - return new ResponseEntity(toPolicyTypeSchemasJson(types), HttpStatus.OK); + return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK); } else { try { Collection types = rics.getRic(ricName).getSupportedPolicyTypes(); - return new ResponseEntity(toPolicyTypeSchemasJson(types), HttpStatus.OK); + return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK); } catch (ServiceException e) { - return new ResponseEntity(e.toString(), HttpStatus.NOT_FOUND); + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); } } } @@ -97,35 +112,40 @@ public class PolicyController { @GetMapping("/policy_schema") @ApiOperation(value = "Returns one policy type schema definition") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy schema", response = Object.class)}) + @ApiResponses( + value = { // + @ApiResponse(code = 200, message = "Policy schema", response = Object.class), + @ApiResponse(code = 404, message = "RIC is not found", response = String.class)}) public ResponseEntity getPolicySchema(@RequestParam(name = "id", required = true) String id) { try { PolicyType type = policyTypes.getType(id); - return new ResponseEntity(type.schema(), HttpStatus.OK); + return new ResponseEntity<>(type.schema(), HttpStatus.OK); } catch (ServiceException e) { - return new ResponseEntity(e.toString(), HttpStatus.NOT_FOUND); + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); } } @GetMapping("/policy_types") - @ApiOperation(value = "Returns policy types") + @ApiOperation(value = "Query policy type names") @ApiResponses( - value = {@ApiResponse( - code = 200, - message = "Policy type names", - response = String.class, - responseContainer = "List")}) + value = { + @ApiResponse( + code = 200, + message = "Policy type names", + response = String.class, + responseContainer = "List"), + @ApiResponse(code = 404, message = "RIC is not found", response = String.class)}) public ResponseEntity getPolicyTypes(@RequestParam(name = "ric", required = false) String ricName) { synchronized (this.policyTypes) { if (ricName == null) { Collection types = this.policyTypes.getAll(); - return new ResponseEntity(toPolicyTypeIdsJson(types), HttpStatus.OK); + return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK); } else { try { Collection types = rics.getRic(ricName).getSupportedPolicyTypes(); - return new ResponseEntity(toPolicyTypeIdsJson(types), HttpStatus.OK); + return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK); } catch (ServiceException e) { - return new ResponseEntity(e.toString(), HttpStatus.NOT_FOUND); + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); } } } @@ -136,51 +156,68 @@ public class PolicyController { @ApiResponses( value = { // @ApiResponse(code = 200, message = "Policy found", response = Object.class), // - @ApiResponse(code = 204, message = "Policy is not found")} // + @ApiResponse(code = 404, message = "Policy is not found")} // ) - public ResponseEntity getPolicy( // @RequestParam(name = "instance", required = true) String instance) { try { Policy p = policies.getPolicy(instance); - return new ResponseEntity(p.json(), HttpStatus.OK); + return new ResponseEntity<>(p.json(), HttpStatus.OK); } catch (ServiceException e) { - return new ResponseEntity(e.getMessage(), HttpStatus.NO_CONTENT); + return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND); } } @DeleteMapping("/policy") - @ApiOperation(value = "Deletes the policy", response = Object.class) - @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy deleted", response = Object.class)}) - public Mono> deletePolicy( // + @ApiOperation(value = "Delete a policy", response = Object.class) + @ApiResponses( + value = { // + @ApiResponse(code = 204, message = "Policy deleted", response = Object.class), + @ApiResponse(code = 404, message = "Policy is not found", response = String.class), + @ApiResponse(code = 423, message = "RIC is locked", response = String.class)}) + public Mono> deletePolicy( // @RequestParam(name = "instance", required = true) String id) { - Policy policy = policies.get(id); - if (policy != null && policy.ric().getState() == Ric.RicState.IDLE) { - policies.remove(policy); - return a1ClientFactory.createA1Client(policy.ric()) // + Policy policy; + try { + policy = policies.getPolicy(id); + keepServiceAlive(policy.ownerServiceName()); + if (policy.ric().getState() != Ric.RicState.IDLE) { + return Mono.just(new ResponseEntity<>("Busy, synchronizing", HttpStatus.LOCKED)); + } + Ric ric = policy.ric(); + return ric.getLock().lock(LockType.SHARED) // // + .flatMap(lock -> a1ClientFactory.createA1Client(policy.ric())) // + .doOnNext(notUsed -> policies.remove(policy)) // .flatMap(client -> client.deletePolicy(policy)) // - .flatMap(notUsed -> { - return Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT)); - }); - } else { + .doOnNext(notUsed -> ric.getLock().unlockBlocking()) // + .doOnError(notUsed -> ric.getLock().unlockBlocking()) // + .flatMap(notUsed -> Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT))) + .onErrorResume(this::handleException); + } catch (ServiceException e) { return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } } @PutMapping(path = "/policy") @ApiOperation(value = "Put a policy", response = String.class) - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy created or updated")}) - public Mono> putPolicy( // - @RequestParam(name = "type", required = true) String typeName, // + @ApiResponses( + value = { // + @ApiResponse(code = 201, message = "Policy created", response = Object.class), // + @ApiResponse(code = 200, message = "Policy updated", response = Object.class), // + @ApiResponse(code = 423, message = "RIC is locked", response = String.class), // + @ApiResponse(code = 404, message = "RIC or policy type is not found", response = String.class) // + }) + public Mono> putPolicy( // + @RequestParam(name = "type", required = false, defaultValue = "") String typeName, // @RequestParam(name = "instance", required = true) String instanceId, // @RequestParam(name = "ric", required = true) String ricName, // @RequestParam(name = "service", required = true) String service, // @RequestBody Object jsonBody) { String jsonString = gson.toJson(jsonBody); - Ric ric = rics.get(ricName); PolicyType type = policyTypes.get(typeName); + keepServiceAlive(service); if (ric != null && type != null && ric.getState() == Ric.RicState.IDLE) { Policy policy = ImmutablePolicy.builder() // .id(instanceId) // @@ -188,45 +225,126 @@ public class PolicyController { .type(type) // .ric(ric) // .ownerServiceName(service) // - .lastModified(getTimeStampUTC()) // + .lastModified(getTimeStampUtc()) // .build(); - return a1ClientFactory.createA1Client(ric) // + + final boolean isCreate = this.policies.get(policy.id()) == null; + + return ric.getLock().lock(LockType.SHARED) // + .flatMap(p -> validateModifiedPolicy(policy)) // + .flatMap(notUsed -> a1ClientFactory.createA1Client(ric)) // .flatMap(client -> client.putPolicy(policy)) // .doOnNext(notUsed -> policies.put(policy)) // - .flatMap(notUsed -> { - return Mono.just(new ResponseEntity<>(HttpStatus.OK)); - }); + .doOnNext(notUsed -> ric.getLock().unlockBlocking()) // + .doOnError(t -> ric.getLock().unlockBlocking()) // + .flatMap(notUsed -> Mono.just(new ResponseEntity<>(isCreate ? HttpStatus.CREATED : HttpStatus.OK))) // + .onErrorResume(this::handleException); } - return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)); + + return ric == null || type == null ? Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)) + : Mono.just(new ResponseEntity<>(HttpStatus.LOCKED)); // Synchronizing + } + + @SuppressWarnings({"unchecked"}) + private Mono> createResponseEntity(String message, HttpStatus status) { + ResponseEntity re = new ResponseEntity<>((T) message, status); + return Mono.just(re); + } + + private Mono> handleException(Throwable throwable) { + if (throwable instanceof WebClientResponseException) { + WebClientResponseException e = (WebClientResponseException) throwable; + return createResponseEntity(e.getResponseBodyAsString(), e.getStatusCode()); + } else if (throwable instanceof RejectionException) { + RejectionException e = (RejectionException) throwable; + return createResponseEntity(e.getMessage(), e.getStatus()); + } else { + return createResponseEntity(throwable.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR); + } + } + + private Mono validateModifiedPolicy(Policy policy) { + // Check that ric is not updated + Policy current = this.policies.get(policy.id()); + if (current != null && !current.ric().name().equals(policy.ric().name())) { + RejectionException e = new RejectionException("Policy cannot change RIC, policyId: " + current.id() + // + ", RIC name: " + current.ric().name() + // + ", new name: " + policy.ric().name(), HttpStatus.CONFLICT); + return Mono.error(e); + } + return Mono.just("OK"); } @GetMapping("/policies") - @ApiOperation(value = "Returns the policies") + @ApiOperation(value = "Query policies") @ApiResponses( value = { - @ApiResponse(code = 200, message = "Policies", response = PolicyInfo.class, responseContainer = "List")}) + @ApiResponse(code = 200, message = "Policies", response = PolicyInfo.class, responseContainer = "List"), + @ApiResponse(code = 404, message = "RIC or type not found", response = String.class)}) public ResponseEntity getPolicies( // @RequestParam(name = "type", required = false) String type, // @RequestParam(name = "ric", required = false) String ric, // @RequestParam(name = "service", required = false) String service) // { + if ((type != null && this.policyTypes.get(type) == null)) { + return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND); + } + if ((ric != null && this.rics.get(ric) == null)) { + return new ResponseEntity<>("RIC not found", HttpStatus.NOT_FOUND); + } synchronized (policies) { - Collection result = null; + String filteredPolicies = policiesToJson(filter(type, ric, service)); + return new ResponseEntity<>(filteredPolicies, HttpStatus.OK); + } + } - if (type != null) { - result = policies.getForType(type); - result = filter(result, null, ric, service); - } else if (service != null) { - result = policies.getForService(service); - result = filter(result, type, ric, null); - } else if (ric != null) { - result = policies.getForRic(ric); - result = filter(result, type, null, service); - } else { - result = policies.getAll(); - } + @GetMapping("/policy_ids") + @ApiOperation(value = "Query policies, only IDs returned") + @ApiResponses( + value = {@ApiResponse(code = 200, message = "Policy ids", response = String.class, responseContainer = "List"), + @ApiResponse(code = 404, message = "RIC or type not found", response = String.class)}) + public ResponseEntity getPolicyIds( // + @RequestParam(name = "type", required = false) String type, // + @RequestParam(name = "ric", required = false) String ric, // + @RequestParam(name = "service", required = false) String service) // + { + if ((type != null && this.policyTypes.get(type) == null)) { + return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND); + } + if ((ric != null && this.rics.get(ric) == null)) { + return new ResponseEntity<>("RIC not found", HttpStatus.NOT_FOUND); + } + synchronized (policies) { + String policyIdsJson = toPolicyIdsJson(filter(type, ric, service)); + return new ResponseEntity<>(policyIdsJson, HttpStatus.OK); + } + } + + @GetMapping("/policy_status") + @ApiOperation(value = "Returns a policy status") // + @ApiResponses( + value = { // + @ApiResponse(code = 200, message = "Policy status", response = Object.class), // + @ApiResponse(code = 404, message = "Policy is not found", response = String.class)} // + ) + public Mono> getPolicyStatus( // + @RequestParam(name = "instance", required = true) String instance) { + try { + Policy policy = policies.getPolicy(instance); - return new ResponseEntity(policiesToJson(result), HttpStatus.OK); + return a1ClientFactory.createA1Client(policy.ric()) // + .flatMap(client -> client.getPolicyStatus(policy)) // + .flatMap(status -> Mono.just(new ResponseEntity<>(status, HttpStatus.OK))) + .onErrorResume(this::handleException); + } catch (ServiceException e) { + return Mono.just(new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND)); + } + } + + private void keepServiceAlive(String name) { + Service s = this.services.get(name); + if (s != null) { + s.keepAlive(); } } @@ -238,7 +356,7 @@ public class PolicyController { if (type == null && ric == null && service == null) { return collection; } - Vector filtered = new Vector<>(); + List filtered = new ArrayList<>(); for (Policy p : collection) { if (include(type, p.type().name()) && include(ric, p.ric().name()) && include(service, p.ownerServiceName())) { @@ -248,24 +366,42 @@ public class PolicyController { return filtered; } + private Collection filter(String type, String ric, String service) { + synchronized (policies) { + if (type != null) { + return filter(policies.getForType(type), null, ric, service); + } else if (service != null) { + return filter(policies.getForService(service), type, ric, null); + } else if (ric != null) { + return filter(policies.getForRic(ric), type, null, service); + } else { + return policies.getAll(); + } + } + } + private String policiesToJson(Collection policies) { - Vector v = new Vector<>(policies.size()); + List v = new ArrayList<>(policies.size()); for (Policy p : policies) { PolicyInfo policyInfo = new PolicyInfo(); policyInfo.id = p.id(); - policyInfo.json = p.json(); + policyInfo.json = fromJson(p.json()); policyInfo.ric = p.ric().name(); policyInfo.type = p.type().name(); policyInfo.service = p.ownerServiceName(); policyInfo.lastModified = p.lastModified(); if (!policyInfo.validate()) { - throw new RuntimeException("BUG, all fields must be set"); + throw new NullPointerException("BUG, all fields must be set"); } v.add(policyInfo); } return gson.toJson(v); } + private Object fromJson(String jsonStr) { + return gson.fromJson(jsonStr, Object.class); + } + private String toPolicyTypeSchemasJson(Collection types) { StringBuilder result = new StringBuilder(); result.append("["); @@ -282,14 +418,22 @@ public class PolicyController { } private String toPolicyTypeIdsJson(Collection types) { - Vector v = new Vector<>(types.size()); + List v = new ArrayList<>(types.size()); for (PolicyType t : types) { v.add(t.name()); } return gson.toJson(v); } - private String getTimeStampUTC() { + private String toPolicyIdsJson(Collection policies) { + List v = new ArrayList<>(policies.size()); + for (Policy p : policies) { + v.add(p.id()); + } + return gson.toJson(v); + } + + private String getTimeStampUtc() { return java.time.Instant.now().toString(); }