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=e29a4e9c2e41358187ddc482865bf4a40cce1249;hb=a76d95e9292f99dfb5cd5782ef6d7bb2ec293fd7;hp=c0932a4cb1c508b18408150eaae01856e4858c7f;hpb=8831a02bce715562f3cacce1691bf4d9d3af206b;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 c0932a4c..e29a4e9c 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,11 +17,17 @@ * 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.Collection; import java.util.Vector; @@ -34,7 +40,6 @@ 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; @@ -46,38 +51,78 @@ import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController +@Api(value = "Policy Management API") public class PolicyController { - private final ApplicationConfig appConfig; private final Rics rics; private final PolicyTypes policyTypes; private final Policies policies; - private final Services services; private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // @Autowired - PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics, Services services) { - this.appConfig = config; + PolicyController(ApplicationConfig config, PolicyTypes types, Policies policies, Rics rics) { this.policyTypes = types; this.policies = policies; this.rics = rics; - this.services = services; } - @GetMapping("/policy_types") - public ResponseEntity getPolicyTypes() { + @GetMapping("/policy_schemas") + @ApiOperation(value = "Returns policy type schema definitions") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Types found")}) + 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); + } 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); + } + } + } - Collection types = this.policyTypes.getAll(); - return new ResponseEntity(policyTypesToJson(types), HttpStatus.OK); + @GetMapping("/policy_schema") + @ApiOperation(value = "Returns one policy type schema definition") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Type found")}) + 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 = "Returns policy types") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy Types found")}) + 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); + } 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 the policy") + @ApiResponses( + value = {@ApiResponse(code = 200, message = "Policy found"), + @ApiResponse(code = 204, message = "Policy is not found")}) public ResponseEntity getPolicy( // @RequestParam(name = "instance", required = true) String instance) { try { - Policy p = policies.get(instance); + Policy p = policies.getPolicy(instance); return new ResponseEntity(p.json(), HttpStatus.OK); } catch (ServiceException e) { return new ResponseEntity(e.getMessage(), HttpStatus.NO_CONTENT); @@ -85,14 +130,18 @@ public class PolicyController { } @DeleteMapping("/policy") - public ResponseEntity deletePolicy( // + @ApiOperation(value = "Deletes the policy") + @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy deleted")}) + public ResponseEntity deletePolicy( // @RequestParam(name = "instance", required = true) String instance) { - Policy p = policies.removeId(instance); - return new ResponseEntity("OK", HttpStatus.OK); + policies.removeId(instance); + return new ResponseEntity<>(HttpStatus.NO_CONTENT); } @GetMapping("/policies") + @ApiOperation(value = "Returns the policies") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Policies found")}) public ResponseEntity getPolicies( // @RequestParam(name = "type", required = false) String type, // @RequestParam(name = "ric", required = false) String ric, // @@ -150,14 +199,25 @@ public class PolicyController { return gson.toJson(v); } - private String policyTypesToJson(Collection types) { - Vector v = new Vector<>(types.size()); + private String toPolicyTypeSchemasJson(Collection types) { + StringBuilder result = new StringBuilder(); + result.append("["); + boolean first = true; for (PolicyType t : types) { - PolicyTypeInfo policyInfo = ImmutablePolicyTypeInfo.builder() // - .schema(t.jsonSchema()) // - .name(t.name()) // - .build(); - v.add(policyInfo); + if (!first) { + result.append(","); + } + first = false; + result.append(t.schema()); + } + result.append("]"); + return result.toString(); + } + + private String toPolicyTypeIdsJson(Collection types) { + Vector v = new Vector<>(types.size()); + for (PolicyType t : types) { + v.add(t.name()); } return gson.toJson(v); } @@ -167,6 +227,8 @@ public class PolicyController { } @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, // @@ -186,7 +248,7 @@ public class PolicyController { .lastModified(getTimeStampUTC()) // .build(); policies.put(policy); - return new ResponseEntity(HttpStatus.OK); + return new ResponseEntity(HttpStatus.CREATED); } catch (ServiceException e) { return new ResponseEntity(e.getMessage(), HttpStatus.NOT_FOUND); }