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=8e34aa9e4c97fee56cbad84843d5d0dc3270a8b5;hpb=7adad623a64bfbb96b3c73ed7c1d0d49aabff659;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 8e34aa9e..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 @@ -17,86 +17,251 @@ * limitations under the License. * ========================LICENSE_END=================================== */ + 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.util.ArrayList; import java.util.Collection; -import java.util.Vector; +import java.util.List; +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.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.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.PutMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Mono; @RestController +@Api(value = "Policy Management API") public class PolicyController { - private final ApplicationConfig appConfig; private final Rics rics; - private final PolicyTypes types; + private final PolicyTypes policyTypes; private final Policies policies; - private final Services services; + private final A1ClientFactory a1ClientFactory; + private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // @Autowired - PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, Services services) { - this.appConfig = config; - this.types = types; + PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, + A1ClientFactory a1ClientFactory) { + this.policyTypes = types; this.policies = policies; this.rics = rics; - this.services = services; + this.a1ClientFactory = a1ClientFactory; + } + + @GetMapping("/policy_schemas") + @ApiOperation(value = "Returns policy type schema definitions") + @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); + } else { + try { + Collection types = rics.getRic(ricName).getSupportedPolicyTypes(); + return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK); + } catch (ServiceException e) { + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); + } + } + } + } + + @GetMapping("/policy_schema") + @ApiOperation(value = "Returns one policy type schema definition") + @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); + } catch (ServiceException e) { + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); + } + } + + @GetMapping("/policy_types") + @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); + } else { + try { + Collection types = rics.getRic(ricName).getSupportedPolicyTypes(); + return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK); + } catch (ServiceException e) { + return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND); + } + } + } } @GetMapping("/policy") + @ApiOperation(value = "Returns a policy configuration") // + @ApiResponses( + 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.get(instance); - return new ResponseEntity(p.json(), HttpStatus.OK); + Policy p = policies.getPolicy(instance); + 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 = "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().getState() == Ric.RicState.IDLE) { + policies.remove(policy); + 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 = "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 Object jsonBody) { + + String jsonString = gson.toJson(jsonBody); + + Ric ric = rics.get(ricName); + PolicyType type = policyTypes.get(typeName); + if (ric != null && type != null && ric.getState() == Ric.RicState.IDLE) { + Policy policy = ImmutablePolicy.builder() // + .id(instanceId) // + .json(jsonString) // + .type(type) // + .ric(ric) // + .ownerServiceName(service) // + .lastModified(getTimeStampUtc()) // + .build(); + + return validateModifiedPolicy(policy) // + .flatMap(x -> a1ClientFactory.createA1Client(ric)) // + .flatMap(client -> client.putPolicy(policy)) // + .doOnNext(notUsed -> policies.put(policy)) // + .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 = "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, // @RequestParam(name = "service", required = false) String service) // { - Collection result = null; - - 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(); + synchronized (policies) { + Collection result = null; + + 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 = filter(policies.getForRic(ric), type, null, service); + } else { + result = policies.getAll(); + } + + 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 new ResponseEntity(toJson(result), HttpStatus.OK); + 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)); + } } private boolean include(String filter, String value) { @@ -107,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())) { @@ -117,42 +282,53 @@ public class PolicyController { return filtered; } - private String toJson(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()) // - .name(p.id()) // - .ric(p.ric().name()) // - .type(p.type().name()).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); } - @PutMapping(path = "/policy") - public ResponseEntity putPolicy( // - @RequestParam(name = "type", required = true) String type, // - @RequestParam(name = "instance", required = true) String instanceId, // - @RequestParam(name = "ric", required = true) String ric, // - @RequestParam(name = "service", required = true) String service, // - @RequestBody String jsonBody) { + private Object fromJson(String jsonStr) { + return gson.fromJson(jsonStr, Object.class); + } - try { - services.getService(service).ping(); - Ric ricObj = rics.getRic(ric); - Policy policy = ImmutablePolicy.builder() // - .id(instanceId) // - .json(jsonBody) // - .type(types.getType(type)) // - .ric(ricObj) // - .ownerServiceName(service) // - .build(); - policies.put(policy); - return new ResponseEntity(HttpStatus.OK); - } catch (ServiceException e) { - return new ResponseEntity(e.getMessage(), HttpStatus.NOT_FOUND); + private String toPolicyTypeSchemasJson(Collection types) { + StringBuilder result = new StringBuilder(); + result.append("["); + boolean first = true; + for (PolicyType t : types) { + if (!first) { + result.append(","); + } + first = false; + result.append(t.schema()); + } + result.append("]"); + return result.toString(); + } + + private String toPolicyTypeIdsJson(Collection types) { + List v = new ArrayList<>(types.size()); + for (PolicyType t : types) { + v.add(t.name()); } + return gson.toJson(v); + } + + private String getTimeStampUtc() { + return java.time.Instant.now().toString(); } }