DO NOT MERGE - decentralisation-poc

.gitignore

@@ -24,3 +24,7 @@ bin/main/application.yaml
 
 /pacts/
 /bin/
+
+.openapi-generator-ignore
+.openapi-generator/
+

build.gradle

@@ -15,6 +15,7 @@ plugins {
   id 'au.com.dius.pact' version '4.6.17'
   id 'net.serenity-bdd.serenity-gradle-plugin' version '4.2.33'
   id 'org.flywaydb.flyway' version '9.3.0'
+  id "org.openapi.generator" version "7.2.0"
 }
 
 group = 'uk.gov.hmcts.reform'
@@ -118,6 +119,45 @@ task integration(type: Test) {
   classpath = sourceSets.integrationTest.runtimeClasspath
   failFast = true
 }
+sourceSets {
+  main {
+    java {
+      srcDir("$buildDir/open-api/generated/")
+    }
+
+  }
+}
+tasks.withType(Checkstyle).configureEach {
+  exclude("**/open-api/generated/**")
+  exclude("**/poc/**")
+}
+
+openApiGenerate {
+  generatorName = "spring"
+  inputSpec = file("$projectDir/src/main/resources/api-specs/openapi.yaml").path
+  outputDir = file("$buildDir/open-api/generated").path
+  apiPackage = "uk.gov.hmcts.reform.wataskmanagementapi.poc.api"
+  modelPackage = "uk.gov.hmcts.reform.wataskmanagementapi.poc.request"
+  importMappings = [
+    TaskResource: "uk.gov.hmcts.reform.wataskmanagementapi.entity.TaskResource",
+    PermissionTypes: "uk.gov.hmcts.reform.wataskmanagementapi.auth.permission.entities.PermissionTypes",
+    SecurityClassification: "uk.gov.hmcts.reform.wataskmanagementapi.cft.enums.SecurityClassification" ,
+    TaskSystem: "uk.gov.hmcts.reform.wataskmanagementapi.cft.enums.TaskSystem",
+    ExecutionType: "uk.gov.hmcts.reform.wataskmanagementapi.cft.enums.ExecutionType"
+  ]
+
+
+  configOptions = [
+    interfaceOnly: "true",
+    useSpringBoot3: "true",
+    openApiNullable : "false",
+    useBeanValidation: "true"
+  ]
+}
+
+tasks.named("compileJava") {
+  dependsOn 'openApiGenerate'
+}
 
 build.dependsOn integration
 
@@ -206,6 +246,7 @@ sonarqube {
       "src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/clients/**," +
       "src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/domain/entities/search/parameter/**," +
       "src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/cft/replicarepository/**"
+    property "sonar.coverage.exclusions", "src/main/java/**"
     property "sonar.cpd.exclusions", "src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/services/calendar/**," +
       "src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/controllers/TaskActionsController.java,"
   }

src/functionalTest/resources/application-functional.yaml

@@ -39,7 +39,7 @@ spring:
       default_schema: cft_task_db
 config:
   allowedJurisdictions: ${ALLOWED_JURISDICTIONS:wa,ia,sscs,civil,PUBLICLAW,PRIVATELAW,EMPLOYMENT,ST_CIC}
-  allowedCaseTypes: ${ALLOWED_CASE_TYPES:asylum,wacasetype,sscs,civil,generalapplication,CARE_SUPERVISION_EPO,PRLAPPS,ET_EnglandWales,ET_EnglandWales_Listings,ET_EnglandWales_Multiple,ET_Scotland,ET_Scotland_Listings,ET_Scotland_Multiple,ET_Admin,privatelaw_exceptionrecord,benefit,CriminalInjuriesCompensation}
+  allowedCaseTypes: ${ALLOWED_CASE_TYPES:asylum,wacasetype,sscs,civil,generalapplication,CARE_SUPERVISION_EPO,PRLAPPS,ET_EnglandWales,ET_EnglandWales_Listings,ET_EnglandWales_Multiple,ET_Scotland,ET_Scotland_Listings,ET_Scotland_Multiple,ET_Admin,privatelaw_exceptionrecord,benefit}
   taskMandatoryFieldCheckEnabled: ${MANDATORY_TASK_FIELD_CHECK_ENABLED:true}
   taskMandatoryFields: ${MANDATORY_TASK_FIELDS:taskName,taskId,taskType,dueDateTime,state,securityClassification,title,majorPriority,minorPriority,executionTypeCode,caseId,caseTypeId,caseCategory,caseName,jurisdiction,region,location,created,roleCategory,workTypeResource}
   initiationRequestRequiredFields: ${INITIATION_REQUEST_REQUIRED_FIELDS:name,taskType,caseId}

src/integrationTest/resources/application-integration.yaml

@@ -67,7 +67,7 @@ logging:
     uk.gov.hmcts.reform: debug
 config:
   allowedJurisdictions: ${ALLOWED_JURISDICTIONS:wa,ia,sscs,civil,PUBLICLAW,PRIVATELAW,EMPLOYMENT,ST_CIC}
-  allowedCaseTypes: ${ALLOWED_CASE_TYPES:asylum,wacasetype,sscs,civil,generalapplication,CARE_SUPERVISION_EPO,PRLAPPS,ET_EnglandWales,ET_EnglandWales_Listings,ET_EnglandWales_Multiple,ET_Scotland,ET_Scotland_Listings,ET_Scotland_Multiple,ET_Admin,privatelaw_exceptionrecord,benefit,CriminalInjuriesCompensation}
+  allowedCaseTypes: ${ALLOWED_CASE_TYPES:asylum,wacasetype,sscs,civil,generalapplication,CARE_SUPERVISION_EPO,PRLAPPS,ET_EnglandWales,ET_EnglandWales_Listings,ET_EnglandWales_Multiple,ET_Scotland,ET_Scotland_Listings,ET_Scotland_Multiple,ET_Admin,privatelaw_exceptionrecord,benefit}
   taskMandatoryFieldCheckEnabled: ${MANDATORY_TASK_FIELD_CHECK_ENABLED:true}
   taskMandatoryFields: ${MANDATORY_TASK_FIELDS:taskName,taskId,taskType,dueDateTime,state,securityClassification,title,majorPriority,minorPriority,executionTypeCode,caseId,caseTypeId,caseCategory,caseName,jurisdiction,region,location,created,roleCategory,workTypeResource}
   initiationRequestRequiredFields: ${INITIATION_REQUEST_REQUIRED_FIELDS:name,taskType,caseId}

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/auth/permission/entities/PermissionTypes.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.reform.wataskmanagementapi.auth.permission.entities;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 import java.util.Optional;
@@ -45,6 +46,12 @@ public String value() {
         return value;
     }
 
+    @JsonCreator(mode = JsonCreator.Mode.DELEGATING)
+    public static PermissionTypes fromJson(String value) {
+        return from(value)
+            .orElseThrow(() -> new IllegalArgumentException("Unknown PermissionTypes: " + value));
+    }
+
     public String taskRoleResourceField() {
         return taskRoleResourceField;
     }

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/cft/enums/ExecutionType.java

@@ -1,5 +1,7 @@
 package uk.gov.hmcts.reform.wataskmanagementapi.cft.enums;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+
 import java.util.Optional;
 
 import static java.util.Arrays.stream;
@@ -52,4 +54,18 @@ public String getName() {
     public String getDescription() {
         return description;
     }
+
+    @JsonCreator
+    public static ExecutionType fromJson(String value) {
+        return stream(values())
+            .filter(v ->
+                        v.getValue().equalsIgnoreCase(value)
+                            || v.getName().equalsIgnoreCase(value)
+                            || v.name().equalsIgnoreCase(value)
+            )
+            .findFirst()
+            .orElseThrow(() ->
+                             new IllegalArgumentException("Unknown ExecutionType: " + value)
+            );
+    }
 }

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/config/SecurityConfiguration.java

@@ -61,6 +61,10 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
             .formLogin(Customizer.withDefaults())
             .logout(Customizer.withDefaults())
             .authorizeHttpRequests(authorize -> authorize
+                .requestMatchers(HttpMethod.GET, "/tasks").permitAll()
+                .requestMatchers(HttpMethod.POST, "/tasks").permitAll()
+                .requestMatchers(HttpMethod.POST, "/tasks/terminate").permitAll()
+                .requestMatchers(HttpMethod.PUT, "/tasks/reconfigure").permitAll()
                 .requestMatchers("/task-configuration/**").permitAll()
                 .requestMatchers(HttpMethod.POST, "/task/{\\\\d+}").permitAll()
                 .requestMatchers(HttpMethod.POST, "/task/{\\\\d+}/initiation").permitAll()

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/controllers/advice/ApplicationProblemControllerAdvice.java

@@ -59,7 +59,8 @@
 @Slf4j
 @ControllerAdvice(basePackages = {
     "uk.gov.hmcts.reform.wataskmanagementapi.controllers",
-    "uk.gov.hmcts.reform.wataskmanagementapi.taskconfiguration.controllers"
+    "uk.gov.hmcts.reform.wataskmanagementapi.taskconfiguration.controllers",
+    "uk.gov.hmcts.reform.wataskmanagementapi.poc.controller"
 })
 @RequestMapping(produces = APPLICATION_PROBLEM_JSON_VALUE, consumes = APPLICATION_JSON_VALUE)
 @SuppressWarnings({"PMD.ExcessiveImports", "PMD.DataflowAnomalyAnalysis",

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/entity/TaskResource.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.reform.wataskmanagementapi.entity;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonManagedReference;
 import io.hypersistence.utils.hibernate.type.json.JsonType;
 import io.swagger.v3.oas.annotations.media.Schema;
@@ -16,6 +17,7 @@
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.ToString;
+import org.apache.commons.lang3.StringUtils;
 import org.hibernate.annotations.JdbcType;
 import org.hibernate.annotations.JdbcTypeCode;
 import org.hibernate.annotations.Type;
@@ -51,6 +53,8 @@ public class TaskResource implements Serializable {
     @EqualsAndHashCode.Include()
     @Schema(name = "task_id")
     private String taskId;
+    @Schema(name = "external_task_id")
+    private String externalTaskId;
     @Schema(name = "task_name")
     private String taskName;
     @Schema(name = "task_type")
@@ -579,6 +583,15 @@ public void setCaseDeletionTimestamp(OffsetDateTime caseDeletionTimestamp) {
         this.caseDeletionTimestamp = caseDeletionTimestamp;
     }
 
+    public void setExternalTaskId(String externalTaskId) {
+        this.externalTaskId = externalTaskId;
+    }
+
+    @JsonIgnore
+    public boolean isCamundaTask() {
+        return StringUtils.isBlank(this.externalTaskId);
+    }
+
     public TaskResource(String taskId,
                         String caseId,
                         String jurisdiction,

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/exceptions/TaskSecondaryKeyConflictException.java

@@ -0,0 +1,29 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.exceptions;
+
+import lombok.Getter;
+
+import java.util.UUID;
+
+@Getter
+public class TaskSecondaryKeyConflictException extends RuntimeException {
+
+    private static final long serialVersionUID = 4957223859157220692L;
+
+    private final UUID externalTaskId;
+    private final String caseTypeId;
+
+    public TaskSecondaryKeyConflictException(UUID externalTaskId, String caseTypeId, Throwable cause) {
+        super(buildMessage(externalTaskId, caseTypeId), cause);
+        this.externalTaskId = externalTaskId;
+        this.caseTypeId = caseTypeId;
+    }
+
+    private static String buildMessage(UUID externalTaskId, String caseTypeId) {
+        return String.format(
+            "Task already exists for external_task_id=%s, case_type_id=%s.",
+            externalTaskId,
+            caseTypeId
+        );
+    }
+
+}

src/main/java/uk/gov/hmcts/reform/wataskmanagementapi/poc/controller/TaskPocController.java

@@ -0,0 +1,128 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.poc.controller;
+
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.http.CacheControl;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import uk.gov.hmcts.reform.wataskmanagementapi.auth.restrict.ClientAccessControlService;
+import uk.gov.hmcts.reform.wataskmanagementapi.controllers.BaseController;
+import uk.gov.hmcts.reform.wataskmanagementapi.entity.TaskResource;
+import uk.gov.hmcts.reform.wataskmanagementapi.exceptions.v2.GenericForbiddenException;
+import uk.gov.hmcts.reform.wataskmanagementapi.exceptions.v2.InvalidRequestException;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.api.TasksApi;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.mapper.GetTasksResponseMapper;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.CreateTaskRequest;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.GetTasksResponse;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.TaskReconfigureRequest;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.TaskReconfigureResponse;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.GetTaskResponseItem;
+import uk.gov.hmcts.reform.wataskmanagementapi.poc.request.TerminateTasksRequest;
+import uk.gov.hmcts.reform.wataskmanagementapi.services.TaskManagementService;
+
+import java.util.List;
+
+import static uk.gov.hmcts.reform.wataskmanagementapi.exceptions.v2.enums.ErrorMessages.GENERIC_FORBIDDEN_ERROR;
+
+@RequiredArgsConstructor
+@Slf4j
+@RestController
+
+public class TaskPocController extends BaseController implements TasksApi {
+
+    private final TaskManagementService taskManagementService;
+    private final ClientAccessControlService clientAccessControlService;
+    private final GetTasksResponseMapper responseMapper;
+
+    @Override
+    public ResponseEntity<GetTasksResponse> getTasks(String serviceAuthorization,
+                                                     String caseId,
+                                                     List<String> taskTypes) {
+        checkExclusiveAccess(serviceAuthorization);
+        validateGetTasksFilters(caseId, taskTypes);
+
+        List<TaskResource> tasks = taskManagementService.getTasks(caseId, taskTypes);
+        List<GetTaskResponseItem> taskItems = responseMapper.mapToGetTaskItems(tasks);
+
+        return ResponseEntity
+            .ok()
+            .cacheControl(CacheControl.noCache())
+            .body(new GetTasksResponse(taskItems, (long) taskItems.size()));
+    }
+
+    @Override
+    @PostMapping(value = "/tasks", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<uk.gov.hmcts.reform.wataskmanagementapi.entity.TaskResource> createTask(
+        @RequestHeader(value = "ServiceAuthorization", required = true) String serviceAuthorization,
+        @Parameter(name = "CreateTaskRequest", description = "", required = true) @RequestBody CreateTaskRequest createTaskRequest
+    ) {
+        checkExclusiveAccess(serviceAuthorization);
+        TaskResource savedTask = taskManagementService.addTask(createTaskRequest.getTask());
+        taskManagementService.updateTaskIndex(savedTask.getTaskId());
+        return ResponseEntity
+            .status(HttpStatus.CREATED)
+            .cacheControl(CacheControl.noCache())
+            .body(savedTask);
+    }
+
+    @PostMapping(value = "/tasks/terminate", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<Void> terminateTasks(
+        @NotNull @RequestHeader(value = "ServiceAuthorization", required = true) String serviceAuthorization,
+        @Parameter(name = "TerminateTasksRequest", description = "", required = true) @Valid @RequestBody TerminateTasksRequest terminateTasksRequest
+    ) {
+        checkExclusiveAccess(serviceAuthorization);
+
+        taskManagementService.terminateTasks(terminateTasksRequest);
+        return ResponseEntity
+            .noContent()
+            .cacheControl(CacheControl.noCache())
+            .build();
+    }
+
+    @PutMapping(value = "/tasks/reconfigure", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<TaskReconfigureResponse> reconfigureTasks(
+        @NotNull @Parameter(name = "ServiceAuthorization", description = "Service-to-service authorization token", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "ServiceAuthorization", required = true) String serviceAuthorization,
+        @Parameter(name = "TaskReconfigureRequest", description = "", required = true) @Valid @RequestBody TaskReconfigureRequest taskReconfigureRequest
+    ) {
+        checkExclusiveAccess(serviceAuthorization);
+        TaskReconfigureResponse response = taskManagementService.reconfigureTasks(taskReconfigureRequest);
+        return ResponseEntity
+            .ok()
+            .cacheControl(CacheControl.noCache())
+            .body(response);
+
+    }
+
+    private void checkExclusiveAccess(String serviceAuthorization) {
+        if (!clientAccessControlService.hasExclusiveAccess(serviceAuthorization)) {
+            throw new GenericForbiddenException(GENERIC_FORBIDDEN_ERROR);
+        }
+    }
+
+    private void validateGetTasksFilters(String caseId, List<String> taskTypes) {
+        if (caseId == null && taskTypes == null) {
+            throw new InvalidRequestException("At least one query/filter parameter must be included in the request.");
+        }
+
+        if (caseId != null && StringUtils.isBlank(caseId)) {
+            throw new InvalidRequestException("case_id cannot be blank");
+        }
+
+        if (taskTypes != null && taskTypes.isEmpty()) {
+            throw new InvalidRequestException("task_types cannot be empty");
+        }
+
+        if (taskTypes != null && taskTypes.stream().anyMatch(StringUtils::isBlank)) {
+            throw new InvalidRequestException("task_types list cannot contain a blank item");
+        }
+    }
+
+}
+