NFDIV-4448: Add configuration for NFD case deletion

ccd-definitions/AuthorisationComplexType.json

@@ -26,5 +26,8 @@
   {"CaseTypeID": "NFD", "CaseFieldID": "applicant2SolicitorOrganisationPolicy", "ListElementCode": "Organisation.OrganisationID", "UserRole": "caseworker-approver", "CRUD": "CRU"},
   {"CaseTypeID": "NFD", "CaseFieldID": "applicant2SolicitorOrganisationPolicy", "ListElementCode": "Organisation.OrganisationName", "UserRole": "caseworker-approver", "CRUD": "CRU"},
   {"CaseTypeID": "NFD", "CaseFieldID": "applicant2SolicitorOrganisationPolicy", "ListElementCode": "PrepopulateToUsersOrganisation", "UserRole": "caseworker-approver", "CRUD": "CRU"},
-  {"CaseTypeID": "NFD", "CaseFieldID": "applicant2SolicitorOrganisationPolicy", "ListElementCode": "PreviousOrganisations", "UserRole": "caseworker-approver", "CRUD": "CRU"}
+  {"CaseTypeID": "NFD", "CaseFieldID": "applicant2SolicitorOrganisationPolicy", "ListElementCode": "PreviousOrganisations", "UserRole": "caseworker-approver", "CRUD": "CRU"},
+  {"CaseTypeID": "NFD", "CaseFieldID": "TTL", "ListElementCode": "SystemTTL", "UserRole": "TTL_profile", "CRUD": "R"},
+  {"CaseTypeID": "NFD", "CaseFieldID": "TTL", "ListElementCode": "Suspended", "UserRole": "TTL_profile", "CRUD": "CRU"},
+  {"CaseTypeID": "NFD", "CaseFieldID": "TTL", "ListElementCode": "OverrideTTL", "UserRole": "TTL_profile", "CRUD": "CRU"}
 ]

src/cftlib/java/uk/gov/hmcts/divorce/cftlib/CftLibConfig.java

@@ -28,7 +28,7 @@ public class CftLibConfig implements CFTLibConfigurer {
     @Override
     public void configure(CFTLib lib) throws Exception {
         var users = Map.of(
-            "[email protected]", List.of("caseworker", "caseworker-divorce", "caseworker-divorce-courtadmin_beta"),
+            "[email protected]", List.of("caseworker", "caseworker-divorce", "caseworker-divorce-courtadmin_beta", "TTL_profile"),
             "[email protected]", List.of(
                 "caseworker", "caseworker-divorce", "caseworker-divorce-superuser", "caseworker-divorce-courtadmin_beta"),
             "[email protected]", List.of("caseworker", "caseworker-divorce", "caseworker-divorce-courtadmin_beta"),
@@ -65,7 +65,9 @@ public void configure(CFTLib lib) throws Exception {
             "pui-case-manager",
             "pui-finance-manager",
             "pui-organisation-manager",
-            "pui-user-manager"
+            "pui-user-manager",
+            "TTL_profile",
+            "idam:cft-ttl-manager"
         );
 
         ResourceLoader resourceLoader = new DefaultResourceLoader();

src/main/java/uk/gov/hmcts/divorce/caseworker/event/CaseworkerHWFPartPaymentMade.java

@@ -54,6 +54,7 @@ public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuild
                 Submitted
             )
             .name(EVENT_NAME_AND_DESCRIPTION)
+            .ttlIncrement(36524)
             .description(EVENT_NAME_AND_DESCRIPTION)
             .aboutToSubmitCallback(this::aboutToSubmit)
             .showEventNotes()

src/main/java/uk/gov/hmcts/divorce/caseworker/event/CaseworkerHwfApplicationAccepted.java

@@ -49,6 +49,7 @@ public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuild
                 RequestedInformationSubmitted,
                 AwaitingHWFEvidence
             )
+            .ttlIncrement(36524)
             .name("HWF application accepted")
             .description("HWF application accepted")
             .aboutToSubmitCallback(this::aboutToSubmit)

src/main/java/uk/gov/hmcts/divorce/caseworker/event/CaseworkerPaymentMade.java

@@ -49,6 +49,7 @@ public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuild
                 RequestedInformationSubmitted,
                 AwaitingHWFEvidence
             )
+            .ttlIncrement(36524)
             .name("Payment made")
             .description("Payment made")
             .aboutToSubmitCallback(this::aboutToSubmit)

src/main/java/uk/gov/hmcts/divorce/citizen/event/CitizenCreateApplication.java

@@ -39,6 +39,7 @@ public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuild
             .event(CITIZEN_CREATE)
             .initialState(Draft)
             .showCondition(NEVER_SHOW)
+            .ttlIncrement(180)
             .name("Create draft case")
             .description("Apply for a divorce or dissolution")
             .aboutToSubmitCallback(this::aboutToSubmit)

src/main/java/uk/gov/hmcts/divorce/citizen/event/CitizenPaymentMade.java

@@ -46,6 +46,7 @@ public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuild
             .event(CITIZEN_PAYMENT_MADE)
             .forState(AwaitingPayment)
             .showCondition(NEVER_SHOW)
+            .ttlIncrement(36524)
             .name("Payment made")
             .description("Payment made")
             .retries(120, 120)

src/main/java/uk/gov/hmcts/divorce/common/ccd/HighLevelDataSetupApp.java

@@ -36,7 +36,9 @@ public class HighLevelDataSetupApp extends DataLoaderToDefinitionStore {
         new CcdRoleConfig("pui-case-manager", "PUBLIC"),
         new CcdRoleConfig("pui-finance-manager", "PUBLIC"),
         new CcdRoleConfig("pui-organisation-manager", "PUBLIC"),
-        new CcdRoleConfig("pui-user-manager", "PUBLIC")
+        new CcdRoleConfig("pui-user-manager", "PUBLIC"),
+        new CcdRoleConfig("TTL_profile", "PUBLIC"),
+        new CcdRoleConfig("idam:cft-ttl-manager", "PUBLIC")
     };
 
     private final CcdEnvironment environment;

src/main/java/uk/gov/hmcts/divorce/common/service/task/SetStateAfterSubmission.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.divorce.common.service.task;
 
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
 import uk.gov.hmcts.ccd.sdk.api.CaseDetails;
@@ -17,6 +18,7 @@
 import static uk.gov.hmcts.divorce.divorcecase.model.State.WelshTranslationReview;
 
 @Component
+@RequiredArgsConstructor
 @Slf4j
 public class SetStateAfterSubmission implements CaseTask {
 

src/main/java/uk/gov/hmcts/divorce/divorcecase/model/CaseData.java

@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
@@ -19,6 +20,7 @@
 import uk.gov.hmcts.ccd.sdk.type.ListValue;
 import uk.gov.hmcts.ccd.sdk.type.OrderSummary;
 import uk.gov.hmcts.ccd.sdk.type.ScannedDocument;
+import uk.gov.hmcts.ccd.sdk.type.TTL;
 import uk.gov.hmcts.ccd.sdk.type.YesOrNo;
 import uk.gov.hmcts.divorce.caseworker.model.CaseNote;
 import uk.gov.hmcts.divorce.divorcecase.model.access.AcaSystemUserAccess;
@@ -31,6 +33,7 @@
 import uk.gov.hmcts.divorce.divorcecase.model.access.DefaultAccess;
 import uk.gov.hmcts.divorce.divorcecase.model.access.SolicitorAndSystemUpdateAccess;
 import uk.gov.hmcts.divorce.divorcecase.model.access.SystemUpdateAndSuperUserAccess;
+import uk.gov.hmcts.divorce.divorcecase.model.access.TtlProfileAccess;
 import uk.gov.hmcts.divorce.document.model.DivorceDocument;
 import uk.gov.hmcts.divorce.document.model.DocumentType;
 import uk.gov.hmcts.divorce.noticeofchange.model.ChangeOfRepresentative;
@@ -328,6 +331,14 @@ public class CaseData {
     @Builder.Default
     private SentNotifications sentNotifications = new SentNotifications();
 
+    @JsonProperty("TTL")
+    @CCD(
+            label = "Set up TTL",
+            typeOverride = FieldType.TTL,
+            access = {TtlProfileAccess.class}
+    )
+    private TTL retainAndDisposeTimeToLive;
+
     @JsonUnwrapped
     @Builder.Default
     private RequestForInformationList requestForInformationList = new RequestForInformationList();

src/main/java/uk/gov/hmcts/divorce/divorcecase/model/UserRole.java

@@ -17,6 +17,7 @@ public enum UserRole implements HasRole {
     JUDGE("caseworker-divorce-judge", "CRU"),
     NOC_APPROVER("caseworker-approver", "CRU"),
     RPA_ROBOT("caseworker-divorce-rparobot", "CRU"),
+    TTL_PROFILE("TTL_profile", "CRU"),
 
     SOLICITOR("caseworker-divorce-solicitor", "CRU"),
     APPLICANT_1_SOLICITOR("[APPONESOLICITOR]", "CRU"),

src/main/java/uk/gov/hmcts/divorce/divorcecase/model/UserRolesForAccessProfiles.java

@@ -0,0 +1,34 @@
+package uk.gov.hmcts.divorce.divorcecase.model;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import uk.gov.hmcts.ccd.sdk.api.HasRole;
+
+@AllArgsConstructor
+@Getter
+public enum UserRolesForAccessProfiles implements HasRole {
+
+    CASE_WORKER("idam:caseworker-divorce-courtadmin_beta", "CRU"),
+    CASE_WORKER_BULK_SCAN("idam:caseworker-divorce-bulkscan", "CRU"),
+    LEGAL_ADVISOR("idam:caseworker-divorce-courtadmin-la", "CRU"),
+    SUPER_USER("idam:caseworker-divorce-superuser", "CRU"),
+    SYSTEMUPDATE("idam:caseworker-divorce-systemupdate", "CRUD"),
+    JUDGE("idam:caseworker-divorce-judge", "CRU"),
+    NOC_APPROVER("idam:caseworker-approver", "CRU"),
+    RPA_ROBOT("idam:caseworker-divorce-rparobot", "CRU"),
+    TTL_MANAGER("idam:cft-ttl-manager", "CRU"),
+
+    SOLICITOR("idam:caseworker-divorce-solicitor", "CRU"),
+    APPLICANT_1_SOLICITOR("[APPONESOLICITOR]", "CRU"),
+    APPLICANT_2_SOLICITOR("[APPTWOSOLICITOR]", "CRU"),
+    ORGANISATION_CASE_ACCESS_ADMINISTRATOR("idam:caseworker-caa", "CRU"),
+
+    CITIZEN("idam:citizen", "CRU"),
+    CREATOR("[CREATOR]", "CRU"),
+    APPLICANT_2("[APPLICANTTWO]", "CRU");
+
+    @JsonValue
+    private final String role;
+    private final String caseTypePermissions;
+}

src/main/java/uk/gov/hmcts/divorce/divorcecase/model/access/RoleToAccessProfiles.java

@@ -0,0 +1,47 @@
+package uk.gov.hmcts.divorce.divorcecase.model.access;
+
+import org.springframework.stereotype.Component;
+import uk.gov.hmcts.ccd.sdk.api.CCDConfig;
+import uk.gov.hmcts.ccd.sdk.api.ConfigBuilder;
+import uk.gov.hmcts.divorce.divorcecase.model.CaseData;
+import uk.gov.hmcts.divorce.divorcecase.model.State;
+import uk.gov.hmcts.divorce.divorcecase.model.UserRolesForAccessProfiles;
+
+@Component
+public class RoleToAccessProfiles implements CCDConfig<CaseData, State, UserRolesForAccessProfiles> {
+    @Override
+    public void configure(ConfigBuilder<CaseData, State, UserRolesForAccessProfiles> configBuilder) {
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.CASE_WORKER)
+                .accessProfiles("caseworker-divorce-courtadmin_beta").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.CASE_WORKER_BULK_SCAN)
+                .accessProfiles("caseworker-divorce-bulkscan").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.LEGAL_ADVISOR)
+                .accessProfiles("caseworker-divorce-courtadmin-la").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.SUPER_USER)
+                .accessProfiles("caseworker-divorce-superuser").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.SYSTEMUPDATE)
+                .accessProfiles("caseworker-divorce-systemupdate").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.JUDGE)
+                .accessProfiles("caseworker-divorce-judge").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.NOC_APPROVER)
+                .accessProfiles("caseworker-approver").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.RPA_ROBOT)
+                .accessProfiles("caseworker-divorce-rparobot").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.TTL_MANAGER)
+                .accessProfiles("TTL_profile").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.SOLICITOR)
+                .accessProfiles("caseworker-divorce-solicitor").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.APPLICANT_1_SOLICITOR)
+                .accessProfiles("[APPONESOLICITOR]").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.APPLICANT_2_SOLICITOR)
+                .accessProfiles("[APPTWOSOLICITOR]").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.ORGANISATION_CASE_ACCESS_ADMINISTRATOR)
+                .accessProfiles("caseworker-caa").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.CITIZEN)
+                .accessProfiles("citizen").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.CREATOR)
+                .accessProfiles("[CREATOR]").build();
+        configBuilder.caseRoleToAccessProfile(UserRolesForAccessProfiles.APPLICANT_2)
+                .accessProfiles("[APPLICANTTWO]").build();
+    }
+}

src/main/java/uk/gov/hmcts/divorce/divorcecase/model/access/TtlProfileAccess.java

@@ -0,0 +1,20 @@
+package uk.gov.hmcts.divorce.divorcecase.model.access;
+
+import com.google.common.collect.HashMultimap;
+import com.google.common.collect.SetMultimap;
+import uk.gov.hmcts.ccd.sdk.api.HasAccessControl;
+import uk.gov.hmcts.ccd.sdk.api.HasRole;
+import uk.gov.hmcts.ccd.sdk.api.Permission;
+
+import static uk.gov.hmcts.divorce.divorcecase.model.UserRole.TTL_PROFILE;
+
+public class TtlProfileAccess implements HasAccessControl {
+    @Override
+    public SetMultimap<HasRole, Permission> getGrants() {
+
+        SetMultimap<HasRole, Permission> grants = HashMultimap.create();
+        grants.putAll(TTL_PROFILE, Permissions.CREATE_READ_UPDATE);
+
+        return grants;
+    }
+}

src/main/java/uk/gov/hmcts/divorce/solicitor/event/SolicitorCreateApplication.java

@@ -131,6 +131,7 @@ private PageBuilder addEventConfig(
             .initialState(Draft)
             .name("Apply: divorce or dissolution")
             .description("Apply: divorce or dissolution")
+            .ttlIncrement(180)
             .showSummary()
             .showEventNotes()
             .endButtonLabel("Save Application")

src/main/java/uk/gov/hmcts/divorce/solicitor/event/SolicitorSubmitApplication.java

@@ -191,6 +191,7 @@ private PageBuilder addEventConfig(final ConfigBuilder<CaseData, State, UserRole
             .description("Agree statement of truth, pay & submit")
             .showSummary()
             .showEventNotes()
+            .ttlIncrement(36524)
             .showCondition("applicationType=\"soleApplication\" OR [STATE]=\"Applicant2Approved\"")
             .endButtonLabel("Submit Application")
             .aboutToStartCallback(this::aboutToStart)

src/main/java/uk/gov/hmcts/divorce/systemupdate/event/ManageCaseTtl.java

@@ -0,0 +1,43 @@
+package uk.gov.hmcts.divorce.systemupdate.event;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+import uk.gov.hmcts.ccd.sdk.api.CCDConfig;
+import uk.gov.hmcts.ccd.sdk.api.ConfigBuilder;
+import uk.gov.hmcts.ccd.sdk.type.TTL;
+import uk.gov.hmcts.divorce.common.ccd.PageBuilder;
+import uk.gov.hmcts.divorce.divorcecase.model.CaseData;
+import uk.gov.hmcts.divorce.divorcecase.model.State;
+import uk.gov.hmcts.divorce.divorcecase.model.UserRole;
+
+import static uk.gov.hmcts.divorce.common.ccd.CcdPageConfiguration.NEVER_SHOW;
+import static uk.gov.hmcts.divorce.divorcecase.model.State.AwaitingPayment;
+import static uk.gov.hmcts.divorce.divorcecase.model.State.Draft;
+import static uk.gov.hmcts.divorce.divorcecase.model.UserRole.TTL_PROFILE;
+import static uk.gov.hmcts.divorce.divorcecase.model.access.Permissions.CREATE_READ_UPDATE;
+
+@Component
+@Slf4j
+public class ManageCaseTtl implements CCDConfig<CaseData, State, UserRole> {
+
+    public static final String MANAGE_CASE_TTL = "manage-case-ttl";
+
+    @Override
+    public void configure(final ConfigBuilder<CaseData, State, UserRole> configBuilder) {
+
+        new PageBuilder(configBuilder
+            .event(MANAGE_CASE_TTL)
+            .forStates(Draft, AwaitingPayment)
+            .name("Resolve time to live")
+            .showCondition(NEVER_SHOW)
+            .description("Resolve time to live")
+                .fields()
+                .complex(CaseData::getRetainAndDisposeTimeToLive)
+                .readonly(TTL::getSystemTTL)
+                .optional(TTL::getOverrideTTL)
+                .optional(TTL::getSuspended)
+                .done()
+            .done()
+            .grant(CREATE_READ_UPDATE, TTL_PROFILE));
+    }
+}

src/test/java/uk/gov/hmcts/divorce/systemupdate/event/ManageCaseTtlTest.java

@@ -0,0 +1,34 @@
+package uk.gov.hmcts.divorce.systemupdate.event;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.junit.jupiter.MockitoExtension;
+import uk.gov.hmcts.ccd.sdk.ConfigBuilderImpl;
+import uk.gov.hmcts.ccd.sdk.api.Event;
+import uk.gov.hmcts.divorce.divorcecase.model.CaseData;
+import uk.gov.hmcts.divorce.divorcecase.model.State;
+import uk.gov.hmcts.divorce.divorcecase.model.UserRole;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static uk.gov.hmcts.divorce.systemupdate.event.ManageCaseTtl.MANAGE_CASE_TTL;
+import static uk.gov.hmcts.divorce.testutil.ConfigTestUtil.createCaseDataConfigBuilder;
+import static uk.gov.hmcts.divorce.testutil.ConfigTestUtil.getEventsFrom;
+
+@ExtendWith(MockitoExtension.class)
+class ManageCaseTtlTest {
+
+    @InjectMocks
+    private ManageCaseTtl systemUpdateTTL;
+
+    @Test
+    void shouldAddConfigurationToConfigBuilder() {
+        final ConfigBuilderImpl<CaseData, State, UserRole> configBuilder = createCaseDataConfigBuilder();
+
+        systemUpdateTTL.configure(configBuilder);
+
+        assertThat(getEventsFrom(configBuilder).values())
+                .extracting(Event::getId)
+                .contains(MANAGE_CASE_TTL);
+    }
+}