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=b5388610caaec61ce538bfa77a0521344271ceee;hb=137656019166c0a9eeb6882e4abf27af8b31444e;hp=e29a4e9c2e41358187ddc482865bf4a40cce1249;hpb=ffe0c150f08205d73ee362f58f492aeb2703f295;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 e29a4e9c..b5388610 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,18 +28,27 @@ import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiResponse; import io.swagger.annotations.ApiResponses; +import java.lang.invoke.MethodHandles; +import java.util.ArrayList; import java.util.Collection; -import java.util.Vector; +import java.util.List; -import org.oransc.policyagent.configuration.ApplicationConfig; +import lombok.Getter; + +import org.oransc.policyagent.clients.A1ClientFactory; 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.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; @@ -49,120 +58,313 @@ 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; + 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 final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // - @Autowired - PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics) { - this.policyTypes = types; - this.policies = policies; - this.rics = rics; - } - @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"), // + @ApiResponse(code = 404, message = "RIC is not found", response = String.class)}) public ResponseEntity getPolicySchemas(@RequestParam(name = "ric", required = false) String ricName) { 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); } } } @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), + @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") - @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"), + @ApiResponse(code = 404, message = "RIC is not found", response = String.class)}) public ResponseEntity getPolicyTypes(@RequestParam(name = "ric", required = false) String ricName) { 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 = 404, message = "Policy is not found")} // + ) public ResponseEntity getPolicy( // - @RequestParam(name = "instance", required = true) String instance) { + @RequestParam(name = "id", required = true) String id) { try { - Policy p = policies.getPolicy(instance); - return new ResponseEntity(p.json(), HttpStatus.OK); + Policy p = policies.getPolicy(id); + 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") - @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy deleted")}) - public ResponseEntity deletePolicy( // - @RequestParam(name = "instance", required = true) String instance) { + @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 not operational", response = String.class)}) + public Mono> deletePolicy( // + @RequestParam(name = "id", required = true) String id) { + try { + Policy policy = policies.getPolicy(id); + keepServiceAlive(policy.ownerServiceName()); + Ric ric = policy.ric(); + return ric.getLock().lock(LockType.SHARED) // + .flatMap(notUsed -> assertRicStateIdle(ric)) // + .flatMap(notUsed -> a1ClientFactory.createA1Client(policy.ric())) // + .doOnNext(notUsed -> policies.remove(policy)) // + .flatMap(client -> client.deletePolicy(policy)) // + .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 = 201, message = "Policy created", response = Object.class), // + @ApiResponse(code = 200, message = "Policy updated", response = Object.class), // + @ApiResponse(code = 423, message = "RIC is not operational", 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 = "id", required = true) String instanceId, // + @RequestParam(name = "ric", required = true) String ricName, // + @RequestParam(name = "service", required = true) String service, // + @RequestParam(name = "transient", required = false, defaultValue = "false") boolean isTransient, // + @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) { + return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND)); + } + Policy policy = ImmutablePolicy.builder() // + .id(instanceId) // + .json(jsonString) // + .type(type) // + .ric(ric) // + .ownerServiceName(service) // + .lastModified(getTimeStampUtc()) // + .isTransient(isTransient) // + .build(); + + final boolean isCreate = this.policies.get(policy.id()) == null; - policies.removeId(instance); - return new ResponseEntity<>(HttpStatus.NO_CONTENT); + return ric.getLock().lock(LockType.SHARED) // + .flatMap(notUsed -> assertRicStateIdle(ric)) // + .flatMap(notUsed -> checkSupportedType(ric, type)) // + .flatMap(notUsed -> validateModifiedPolicy(policy)) // + .flatMap(notUsed -> a1ClientFactory.createA1Client(ric)) // + .flatMap(client -> client.putPolicy(policy)) // + .doOnNext(notUsed -> policies.put(policy)) // + .doOnNext(notUsed -> ric.getLock().unlockBlocking()) // + .doOnError(trowable -> ric.getLock().unlockBlocking()) // + .flatMap(notUsed -> Mono.just(new ResponseEntity<>(isCreate ? HttpStatus.CREATED : HttpStatus.OK))) // + .onErrorResume(this::handleException); + } + + @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); + logger.debug("Request rejected, {}", e.getMessage()); + return Mono.error(e); + } + return Mono.just("OK"); + } + + private Mono checkSupportedType(Ric ric, PolicyType type) { + if (!ric.isSupportingType(type.name())) { + logger.debug("Request rejected, type not supported, RIC: {}", ric); + RejectionException e = new RejectionException( + "Type: " + type.name() + " not supported by RIC: " + ric.name(), HttpStatus.NOT_FOUND); + return Mono.error(e); + } + return Mono.just("OK"); + } + + private Mono assertRicStateIdle(Ric ric) { + if (ric.getState() == Ric.RicState.AVAILABLE) { + return Mono.just("OK"); + } else { + logger.debug("Request rejected RIC not IDLE, ric: {}", ric); + RejectionException e = new RejectionException( + "Ric is not operational, RIC name: " + ric.name() + ", state: " + ric.getState(), HttpStatus.LOCKED); + return Mono.error(e); + } } @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"), + @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) // { - Collection result = null; + 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); + } - 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(); + String filteredPolicies = policiesToJson(filter(type, ric, service)); + return new ResponseEntity<>(filteredPolicies, HttpStatus.OK); + } + + @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); } - return new ResponseEntity(policiesToJson(result), HttpStatus.OK); + 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 = "id", required = true) String id) { + try { + Policy policy = policies.getPolicy(id); + + 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(); + } } private boolean include(String filter, String value) { @@ -173,7 +375,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())) { @@ -183,22 +385,40 @@ public class PolicyController { return filtered; } + private Collection filter(String type, String ric, String service) { + 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 = 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()) { + logger.error("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("["); @@ -215,43 +435,23 @@ 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() { - return java.time.Instant.now().toString(); + private String toPolicyIdsJson(Collection policies) { + List v = new ArrayList<>(policies.size()); + for (Policy p : policies) { + v.add(p.id()); + } + return gson.toJson(v); } - @PutMapping(path = "/policy") - @ApiOperation(value = "Create the policy") - @ApiResponses(value = {@ApiResponse(code = 201, message = "Policy created")}) - 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) { - - try { - // services.getService(service).ping(); - Ric ricObj = rics.getRic(ric); - Policy policy = ImmutablePolicy.builder() // - .id(instanceId) // - .json(jsonBody) // - .type(policyTypes.getType(type)) // - .ric(ricObj) // - .ownerServiceName(service) // - .lastModified(getTimeStampUTC()) // - .build(); - policies.put(policy); - return new ResponseEntity(HttpStatus.CREATED); - } catch (ServiceException e) { - return new ResponseEntity(e.getMessage(), HttpStatus.NOT_FOUND); - } + private String getTimeStampUtc() { + return java.time.Instant.now().toString(); } }