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=b2d0fab846063eace1cfe7176c9277aa492cb41f;hpb=3b5213d7ef998e3f76d58a767230013be0a7927f;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 b2d0fab8..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,24 +17,33 @@ * 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; -import org.oransc.policyagent.Beans; + 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.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; @@ -42,37 +51,97 @@ 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 types; + private final PolicyTypes policyTypes; private final Policies policies; private static Gson gson = new GsonBuilder() // .serializeNulls() // .create(); // @Autowired - PolicyController(Beans beans) { - this.appConfig = beans.getApplicationConfig(); - this.rics = beans.getRics(); - this.types = beans.getPolicyTypes(); - this.policies = beans.getPolicies(); + 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")}) + 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); + } + } + } + + @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 = false, defaultValue = "new") String instance) { + @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); } } + @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) { + + 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, // @@ -93,7 +162,7 @@ public class PolicyController { result = policies.getAll(); } - return new ResponseEntity(toJson(result), HttpStatus.OK); + return new ResponseEntity(policiesToJson(result), HttpStatus.OK); } private boolean include(String filter, String value) { @@ -114,20 +183,52 @@ public class PolicyController { return filtered; } - private String toJson(Collection policies) { + private String policiesToJson(Collection policies) { Vector v = new Vector<>(policies.size()); for (Policy p : policies) { PolicyInfo policyInfo = ImmutablePolicyInfo.builder() // .json(p.json()) // - .name(p.id()) // + .id(p.id()) // .ric(p.ric().name()) // - .type(p.type().name()).build(); + .type(p.type().name()) // + .service(p.ownerServiceName()) // + .lastModified(p.lastModified()) // + .build(); v.add(policyInfo); } return gson.toJson(v); } + 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) { + Vector v = new Vector<>(types.size()); + for (PolicyType t : types) { + v.add(t.name()); + } + return gson.toJson(v); + } + + private String getTimeStampUTC() { + return java.time.Instant.now().toString(); + } + @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, // @@ -136,16 +237,18 @@ public class PolicyController { @RequestBody String jsonBody) { try { + // services.getService(service).ping(); Ric ricObj = rics.getRic(ric); Policy policy = ImmutablePolicy.builder() // .id(instanceId) // .json(jsonBody) // - .type(types.getType(type)) // + .type(policyTypes.getType(type)) // .ric(ricObj) // .ownerServiceName(service) // + .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); }