Merge "Fixed some sonar warnings"
[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / controllers / consumer / ConsumerController.java
index 7dfaeca..ff04522 100644 (file)
@@ -20,6 +20,7 @@
 
 package org.oransc.enrichment.controllers.consumer;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
@@ -29,15 +30,24 @@ import io.swagger.annotations.ApiParam;
 import io.swagger.annotations.ApiResponse;
 import io.swagger.annotations.ApiResponses;
 
+import java.lang.invoke.MethodHandles;
 import java.util.ArrayList;
 import java.util.List;
 
+import org.everit.json.schema.Schema;
+import org.everit.json.schema.loader.SchemaLoader;
+import org.json.JSONObject;
+import org.oransc.enrichment.clients.ProducerCallbacks;
+import org.oransc.enrichment.configuration.ApplicationConfig;
 import org.oransc.enrichment.controllers.ErrorResponse;
+import org.oransc.enrichment.exceptions.ServiceException;
 import org.oransc.enrichment.repository.EiJob;
 import org.oransc.enrichment.repository.EiJobs;
 import org.oransc.enrichment.repository.EiType;
 import org.oransc.enrichment.repository.EiTypes;
 import org.oransc.enrichment.repository.ImmutableEiJob;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -49,22 +59,31 @@ import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;
 
+@SuppressWarnings("java:S3457") // No need to call "toString()" method as formatting and string ..
 @RestController("ConsumerController")
 @Api(tags = {ConsumerConsts.CONSUMER_API_NAME})
 public class ConsumerController {
 
+    private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+    @Autowired
+    ApplicationConfig applicationConfig;
+
     @Autowired
     private EiJobs eiJobs;
 
     @Autowired
     private EiTypes eiTypes;
 
+    @Autowired
+    ProducerCallbacks producerCallbacks;
+
     private static Gson gson = new GsonBuilder() //
         .serializeNulls() //
         .create(); //
 
-    @GetMapping(path = ConsumerConsts.A1E_API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Query EI type identifiers", notes = "DETAILS TBD")
+    @GetMapping(path = ConsumerConsts.API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiOperation(value = "EI type identifiers", notes = "")
     @ApiResponses(
         value = { //
             @ApiResponse(
@@ -77,14 +96,14 @@ public class ConsumerController {
     ) {
         List<String> result = new ArrayList<>();
         for (EiType eiType : this.eiTypes.getAllEiTypes()) {
-            result.add(eiType.id());
+            result.add(eiType.getId());
         }
 
         return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
     }
 
-    @GetMapping(path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Definitions for an individual EI Type", notes = "Query EI type")
+    @GetMapping(path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiOperation(value = "Individual EI type", notes = "")
     @ApiResponses(
         value = { //
             @ApiResponse(code = 200, message = "EI type", response = ConsumerEiTypeInfo.class), //
@@ -104,9 +123,9 @@ public class ConsumerController {
     }
 
     @GetMapping(
-        path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}/eijobs",
+        path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs",
         produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Query EI job identifiers", notes = "Returns the EI Job identifiers for an EI Type")
+    @ApiOperation(value = "EI job identifiers", notes = "")
     @ApiResponses(
         value = { //
             @ApiResponse(
@@ -138,7 +157,7 @@ public class ConsumerController {
     }
 
     @GetMapping(
-        path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
+        path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
         produces = MediaType.APPLICATION_JSON_VALUE)
     @ApiOperation(value = "Individual EI Job", notes = "")
     @ApiResponses(
@@ -161,7 +180,7 @@ public class ConsumerController {
     }
 
     @GetMapping(
-        path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}/status",
+        path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}/status",
         produces = MediaType.APPLICATION_JSON_VALUE)
     @ApiOperation(value = "EI Job status", notes = "")
     @ApiResponses(
@@ -184,13 +203,14 @@ public class ConsumerController {
     }
 
     private ConsumerEiJobStatus toEiJobStatus(EiJob job) {
+        // TODO
         return new ConsumerEiJobStatus(ConsumerEiJobStatus.OperationalState.ENABLED);
     }
 
     @DeleteMapping(
-        path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
+        path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
         produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Individual EI Job", notes = "Delete EI job")
+    @ApiOperation(value = "Individual EI Job", notes = "")
     @ApiResponses(
         value = { //
             @ApiResponse(code = 200, message = "Not used", response = void.class),
@@ -203,7 +223,9 @@ public class ConsumerController {
         @PathVariable("eiTypeId") String eiTypeId, //
         @PathVariable("eiJobId") String eiJobId) {
         try {
-            this.eiJobs.remove(eiJobId);
+            EiJob job = this.eiJobs.getJob(eiJobId);
+            this.eiJobs.remove(job);
+            this.producerCallbacks.notifyProducersJobDeleted(job);
             return new ResponseEntity<>(HttpStatus.NO_CONTENT);
         } catch (Exception e) {
             return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
@@ -211,10 +233,10 @@ public class ConsumerController {
     }
 
     @PutMapping(
-        path = ConsumerConsts.A1E_API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}", //
+        path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}", //
         produces = MediaType.APPLICATION_JSON_VALUE, //
         consumes = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Individual EI Job", notes = "Create or update an EI Job")
+    @ApiOperation(value = "Individual EI Job", notes = "")
     @ApiResponses(
         value = { //
             @ApiResponse(code = 201, message = "Job created", response = void.class), //
@@ -228,31 +250,59 @@ public class ConsumerController {
         @PathVariable("eiJobId") String eiJobId, //
         @RequestBody ConsumerEiJobInfo eiJobInfo) {
         try {
-            this.eiTypes.getType(eiTypeId); // Just to check that the type exists
-            final boolean newJob = this.eiJobs.get(eiJobId) == null;
-            this.eiJobs.put(toEiJob(eiJobInfo, eiJobId, eiTypeId));
+            EiType eiType = this.eiTypes.getType(eiTypeId);
+            validateJobData(eiType.getJobDataSchema(), eiJobInfo.jobData);
+            EiJob existingEiJob = this.eiJobs.get(eiJobId);
+            final boolean newJob = existingEiJob == null;
+            if (existingEiJob != null && !existingEiJob.type().getId().equals(eiTypeId)) {
+                return ErrorResponse.create("Not allowed to change type for existing EI job", HttpStatus.CONFLICT);
+            }
+            EiJob newEiJob = toEiJob(eiJobInfo, eiJobId, eiType);
+            this.eiJobs.put(newEiJob);
+            this.producerCallbacks.notifyProducersJobCreated(newEiJob);
             return new ResponseEntity<>(newJob ? HttpStatus.CREATED : HttpStatus.OK);
         } catch (Exception e) {
             return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
         }
     }
 
+    private void validateJobData(Object schemaObj, Object object) throws ServiceException {
+        if (schemaObj == null) {
+            return; // schema is optional for now
+        }
+        try {
+            ObjectMapper mapper = new ObjectMapper();
+
+            String schemaAsString = mapper.writeValueAsString(schemaObj);
+            JSONObject schemaJSON = new JSONObject(schemaAsString);
+            Schema schema = SchemaLoader.load(schemaJSON);
+
+            String objectAsString = mapper.writeValueAsString(object);
+            JSONObject json = new JSONObject(objectAsString);
+            schema.validate(json);
+        } catch (Exception e) {
+            throw new ServiceException("Json validation failure", e);
+        }
+
+    }
+
     // Status TBD
 
-    private EiJob toEiJob(ConsumerEiJobInfo info, String id, String typeId) {
+    private EiJob toEiJob(ConsumerEiJobInfo info, String id, EiType type) {
         return ImmutableEiJob.builder() //
             .id(id) //
-            .typeId(typeId) //
+            .type(type) //
             .owner(info.owner) //
             .jobData(info.jobData) //
+            .targetUri(info.targetUri) //
             .build();
     }
 
     private ConsumerEiTypeInfo toEiTypeInfo(EiType t) {
-        return new ConsumerEiTypeInfo(t.jobDataSchema());
+        return new ConsumerEiTypeInfo(t.getJobDataSchema());
     }
 
     private ConsumerEiJobInfo toEiJobInfo(EiJob s) {
-        return new ConsumerEiJobInfo(s.jobData(), s.owner());
+        return new ConsumerEiJobInfo(s.jobData(), s.owner(), s.targetUri());
     }
 }