Adding validation of updated policies
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / controllers / PolicyController.java
index 97fe2a5..b102964 100644 (file)
@@ -28,8 +28,9 @@ 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;
@@ -76,18 +77,20 @@ public class PolicyController {
 
     @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<String> getPolicySchemas(@RequestParam(name = "ric", required = false) String ricName) {
         synchronized (this.policyTypes) {
             if (ricName == null) {
                 Collection<PolicyType> types = this.policyTypes.getAll();
-                return new ResponseEntity<String>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
+                return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
             } else {
                 try {
                     Collection<PolicyType> types = rics.getRic(ricName).getSupportedPolicyTypes();
-                    return new ResponseEntity<String>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
+                    return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
                 } catch (ServiceException e) {
-                    return new ResponseEntity<String>(e.toString(), HttpStatus.NOT_FOUND);
+                    return new ResponseEntity<>(e.toString(), HttpStatus.NOT_FOUND);
                 }
             }
         }
@@ -95,53 +98,60 @@ 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<String> getPolicySchema(@RequestParam(name = "id", required = true) String id) {
         try {
             PolicyType type = policyTypes.getType(id);
-            return new ResponseEntity<String>(type.schema(), HttpStatus.OK);
+            return new ResponseEntity<>(type.schema(), HttpStatus.OK);
         } catch (ServiceException e) {
-            return new ResponseEntity<String>(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<String> getPolicyTypes(@RequestParam(name = "ric", required = false) String ricName) {
         synchronized (this.policyTypes) {
             if (ricName == null) {
                 Collection<PolicyType> types = this.policyTypes.getAll();
-                return new ResponseEntity<String>(toPolicyTypeIdsJson(types), HttpStatus.OK);
+                return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK);
             } else {
                 try {
                     Collection<PolicyType> types = rics.getRic(ricName).getSupportedPolicyTypes();
-                    return new ResponseEntity<String>(toPolicyTypeIdsJson(types), HttpStatus.OK);
+                    return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK);
                 } catch (ServiceException e) {
-                    return new ResponseEntity<String>(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<String> getPolicy( //
         @RequestParam(name = "instance", required = true) String instance) {
         try {
             Policy p = policies.getPolicy(instance);
-            return new ResponseEntity<String>(p.json(), HttpStatus.OK);
+            return new ResponseEntity<>(p.json(), HttpStatus.OK);
         } catch (ServiceException e) {
-            return new ResponseEntity<String>(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<ResponseEntity<Void>> deletePolicy( //
         @RequestParam(name = "instance", required = true) String id) {
         Policy policy = policies.get(id);
@@ -149,48 +159,61 @@ public class PolicyController {
             policies.remove(policy);
             return a1ClientFactory.createA1Client(policy.ric()) //
                 .flatMap(client -> client.deletePolicy(policy)) //
-                .flatMap(notUsed -> {
-                    return Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT));
-                });
+                .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<ResponseEntity<String>> 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.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 a1ClientFactory.createA1Client(ric) //
+
+            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<Object> 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<String> getPolicies( //
         @RequestParam(name = "type", required = false) String type, //
         @RequestParam(name = "ric", required = false) String ric, //
@@ -206,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<String>(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<ResponseEntity<String>> 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));
         }
     }
 
@@ -224,7 +272,7 @@ public class PolicyController {
         if (type == null && ric == null && service == null) {
             return collection;
         }
-        Vector<Policy> filtered = new Vector<>();
+        List<Policy> filtered = new ArrayList<>();
         for (Policy p : collection) {
             if (include(type, p.type().name()) && include(ric, p.ric().name())
                 && include(service, p.ownerServiceName())) {
@@ -234,22 +282,28 @@ public class PolicyController {
         return filtered;
     }
 
-    private String policiesToJson(Collection<Policy> policies) {
-        Vector<PolicyInfo> v = new Vector<>(policies.size());
+    private String policiesToJson(Collection<Policy> policies) throws ServiceException {
+        List<PolicyInfo> 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<PolicyType> types) {
         StringBuilder result = new StringBuilder();
         result.append("[");
@@ -266,14 +320,14 @@ public class PolicyController {
     }
 
     private String toPolicyTypeIdsJson(Collection<PolicyType> types) {
-        Vector<String> v = new Vector<>(types.size());
+        List<String> 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();
     }