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=b102964c26f014b5049301435aa94e7a748f568f;hb=8936c783ff4f362fbc9b96b658b5defb0701da54;hp=affce2c1e0717db4731bd39859e4b6a5be90dab8;hpb=d7fbc4199c419bb5c849e2bbec969294ebcee951;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 affce2c1..b102964c 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,10 +28,11 @@ 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 org.oransc.policyagent.clients.A1Client; +import org.oransc.policyagent.clients.A1ClientFactory; import org.oransc.policyagent.configuration.ApplicationConfig; import org.oransc.policyagent.exceptions.ServiceException; import org.oransc.policyagent.repository.ImmutablePolicy; @@ -59,34 +60,37 @@ public class PolicyController { private final Rics rics; private final PolicyTypes policyTypes; private final Policies policies; - private final A1Client a1Client; + private final A1ClientFactory a1ClientFactory; private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // @Autowired - PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, A1Client a1Client) { + PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, + A1ClientFactory a1ClientFactory) { this.policyTypes = types; this.policies = policies; this.rics = rics; - this.a1Client = a1Client; + this.a1ClientFactory = a1ClientFactory; } @GetMapping("/policy_schemas") @ApiOperation(value = "Returns policy type schema definitions") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Types found")}) + @ApiResponses( + value = { + @ApiResponse(code = 200, message = "Policy schemas", response = Object.class, responseContainer = "List")}) 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); } } } @@ -94,100 +98,122 @@ public class PolicyController { @GetMapping("/policy_schema") @ApiOperation(value = "Returns one policy type schema definition") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Type found")}) + @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy schema", response = Object.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") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Types found")}) + @ApiOperation(value = "Query policy type names") + @ApiResponses( + value = {@ApiResponse( + code = 200, + message = "Policy type names", + response = String.class, + responseContainer = "List")}) 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); } } } } @GetMapping("/policy") - @ApiOperation(value = "Returns the policy") + @ApiOperation(value = "Returns a policy configuration") // @ApiResponses( - value = {@ApiResponse(code = 200, message = "Policy found"), - @ApiResponse(code = 204, message = "Policy is not found")}) + value = { // + @ApiResponse(code = 200, message = "Policy found", response = Object.class), // + @ApiResponse(code = 204, 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.NO_CONTENT); } } @DeleteMapping("/policy") - @ApiOperation(value = "Deletes the policy") - @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy deleted")}) + @ApiOperation(value = "Delete a policy", response = Object.class) + @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy deleted", response = Object.class)}) public Mono> deletePolicy( // @RequestParam(name = "instance", required = true) String id) { Policy policy = policies.get(id); - if (policy != null && policy.ric().state().equals(Ric.RicState.IDLE)) { + if (policy != null && policy.ric().getState() == Ric.RicState.IDLE) { policies.remove(policy); - return a1Client.deletePolicy(policy.ric().getConfig().baseUrl(), id) // - .flatMap(notUsed -> { - return Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT)); - }); + return a1ClientFactory.createA1Client(policy.ric()) // + .flatMap(client -> client.deletePolicy(policy)) // + .flatMap(notUsed -> Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT))); } else { return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } } @PutMapping(path = "/policy") - @ApiOperation(value = "Create the policy") - @ApiResponses(value = {@ApiResponse(code = 201, message = "Policy created")}) + @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, // @RequestParam(name = "instance", required = true) String instanceId, // @RequestParam(name = "ric", required = true) String ricName, // @RequestParam(name = "service", required = true) String service, // - @RequestBody String jsonBody) { + @RequestBody Object jsonBody) { + + String jsonString = gson.toJson(jsonBody); Ric ric = rics.get(ricName); PolicyType type = policyTypes.get(typeName); - if (ric != null && type != null && ric.state().equals(Ric.RicState.IDLE)) { + if (ric != null && type != null && ric.getState() == Ric.RicState.IDLE) { Policy policy = ImmutablePolicy.builder() // .id(instanceId) // - .json(jsonBody) // + .json(jsonString) // .type(type) // .ric(ric) // .ownerServiceName(service) // - .lastModified(getTimeStampUTC()) // + .lastModified(getTimeStampUtc()) // .build(); - return a1Client.putPolicy(policy) // + + return validateModifiedPolicy(policy) // + .flatMap(x -> a1ClientFactory.createA1Client(ric)) // + .flatMap(client -> client.putPolicy(policy)) // .doOnNext(notUsed -> policies.put(policy)) // - .flatMap(notUsed -> { - return Mono.just(new ResponseEntity<>(HttpStatus.CREATED)); - }); + .flatMap(notUsed -> Mono.just(new ResponseEntity<>(HttpStatus.OK))); } return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } + private Mono validateModifiedPolicy(Policy policy) { + // Check that ric is not updated + Policy current = this.policies.get(policy.id()); + if (current != null) { + if (!current.ric().name().equals(policy.ric().name())) { + return Mono.error(new Exception("Policy cannot change RIC or service")); + } + } + return Mono.just("OK"); + } + @GetMapping("/policies") - @ApiOperation(value = "Returns the policies") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policies found")}) + @ApiOperation(value = "Query policies") + @ApiResponses( + value = { + @ApiResponse(code = 200, message = "Policies", response = PolicyInfo.class, responseContainer = "List")}) public ResponseEntity getPolicies( // @RequestParam(name = "type", required = false) String type, // @RequestParam(name = "ric", required = false) String ric, // @@ -203,13 +229,38 @@ public class PolicyController { result = policies.getForService(service); result = filter(result, type, ric, null); } else if (ric != null) { - result = policies.getForRic(ric); - result = filter(result, type, null, service); + result = filter(policies.getForRic(ric), type, null, service); } else { result = policies.getAll(); } - return new ResponseEntity(policiesToJson(result), HttpStatus.OK); + String policiesJson; + try { + policiesJson = policiesToJson(result); + } catch (ServiceException e) { + return new ResponseEntity<>(e.getMessage(), HttpStatus.NO_CONTENT); + } + return new ResponseEntity<>(policiesJson, HttpStatus.OK); + } + } + + @GetMapping("/policy_status") + @ApiOperation(value = "Returns a policy status") // + @ApiResponses( + value = { // + @ApiResponse(code = 200, message = "Policy status", response = Object.class), // + @ApiResponse(code = 204, 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 a1ClientFactory.createA1Client(policy.ric()) // + .flatMap(client -> client.getPolicyStatus(policy)) // + .flatMap(status -> Mono.just(new ResponseEntity<>(status, HttpStatus.OK))); + } catch (ServiceException e) { + return Mono.just(new ResponseEntity<>(e.getMessage(), HttpStatus.NO_CONTENT)); } } @@ -221,7 +272,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())) { @@ -231,22 +282,28 @@ public class PolicyController { return filtered; } - private String policiesToJson(Collection policies) { - Vector v = new Vector<>(policies.size()); + private String policiesToJson(Collection policies) throws ServiceException { + List v = new ArrayList<>(policies.size()); for (Policy p : policies) { - PolicyInfo policyInfo = ImmutablePolicyInfo.builder() // - .json(p.json()) // - .id(p.id()) // - .ric(p.ric().name()) // - .type(p.type().name()) // - .service(p.ownerServiceName()) // - .lastModified(p.lastModified()) // - .build(); + PolicyInfo policyInfo = new PolicyInfo(); + policyInfo.id = p.id(); + 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 ServiceException("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("["); @@ -263,14 +320,14 @@ 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 getTimeStampUtc() { return java.time.Instant.now().toString(); }