Dtscci 1461 plus database

build.gradle

@@ -289,7 +289,7 @@ sonarqube {
     property "sonar.cpd.exclusions", "**/*DocumentManagementService.java, **/*Spec*.java, **/*CcdDashboardClaimantClaimMatcher.java, **/*CcdDashboardDefendantClaimMatcher.java"
     property "sonar.exclusions", "**/hmc/model/**, **/model/hearingvalues/**, **/handler/callback/camunda/dashboardnotifications/claimant/CCJRequestedDashboardNotificationHandler.java, **/handler/callback/camunda/dashboardnotifications/claimant/ClaimantCCJResponseNotificationHandler.java" +
       ", **/handler/callback/camunda/dashboardnotifications/claimant/ClaimantResponseNotificationHandler.java, **/utils/**, **/filters/**, **/handler/callback/camunda/dashboardnotifications/defendant/MoreTimeRequestedDashboardNotificationDefendantHandler.java, **/handler/callback/camunda/dashboardnotifications/claimant/ClaimantMediationSuccessfulDashboardNotificationHandler.java, **/handler/callback/camunda/dashboardnotifications/claimant/ClaimSettledDashboardNotificationHandler.java, **/handler/callback/camunda/dashboardnotifications/claimant/HearingScheduledClaimantNotificationHandler.java, **/handler/callback/camunda/dashboardnotifications/defendant/SettleClaimPaidInFullDefendantDashboardNotificationHandler.java, **/handler/callback/camunda/dashboardnotifications/defendant/DefendantNotifyDiscontinuanceDashboardNotificationHandler.java" +
-      ",**/utils/CaseQueriesUtil.java, **/handler/callback/user/RaiseQueryCallbackHandler.java, **/handler/callback/user/RespondQueryCallbackHandler.java"
+      ",**/utils/CaseQueriesUtil.java, **/handler/callback/user/RaiseQueryCallbackHandler.java, **/handler/callback/user/RespondQueryCallbackHandler.java, **/notification/handlers/Notifier.java"
     property "sonar.host.url", "https://sonar.reform.hmcts.net/"
     property "sonar.web.javaOpts", "-Xmx2G"
   }

dashboard-notifications/src/main/java/uk/gov/hmcts/reform/dashboard/entities/NotificationExceptionRecordEntity.java

@@ -0,0 +1,67 @@
+package uk.gov.hmcts.reform.dashboard.entities;
+
+import com.vladmihalcea.hibernate.type.array.StringArrayType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.hibernate.annotations.Type;
+import org.hibernate.annotations.TypeDef;
+import org.hibernate.annotations.TypeDefs;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+import javax.persistence.Table;
+import javax.validation.constraints.NotNull;
+import java.io.Serial;
+import java.io.Serializable;
+import java.time.OffsetDateTime;
+import java.util.List;
+import java.util.UUID;
+
+@lombok.Data
+@lombok.Builder(toBuilder = true)
+@lombok.NoArgsConstructor
+@lombok.AllArgsConstructor
+@Entity
+@Table(name = "notification_exception_record", schema = "dbs")
+@TypeDefs({
+    @TypeDef(
+        name = "string-array",
+        typeClass = StringArrayType.class
+        )
+})
+public class NotificationExceptionRecordEntity implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 8313686152850559308L;
+
+    @Id
+    @NotNull
+    @Schema(name = "id")
+    private UUID id;
+
+    @Schema(name = "reference")
+    private String reference;
+
+    @Schema(name = "task_id")
+    private String taskId;
+
+    @Schema(name = "party_type")
+    private String partyType;
+
+    @Schema(name = "successful_actions")
+    @Type(type = "string-array")
+    @Column(
+        name = "successful_actions",
+        columnDefinition = "text[]"
+    )
+    private List<String> successfulActions;
+
+    @Schema(name = "retry_count")
+    private int retryCount;
+
+    @Schema(name = "created_at")
+    private OffsetDateTime createdAt;
+
+    @Schema(name = "updated_on")
+    private OffsetDateTime updatedOn;
+}

dashboard-notifications/src/main/java/uk/gov/hmcts/reform/dashboard/repositories/NotificationExceptionRecordRepository.java

@@ -0,0 +1,15 @@
+package uk.gov.hmcts.reform.dashboard.repositories;
+
+import uk.gov.hmcts.reform.dashboard.entities.NotificationExceptionRecordEntity;
+
+import java.util.Optional;
+import java.util.UUID;
+
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface NotificationExceptionRecordRepository extends CrudRepository<NotificationExceptionRecordEntity, UUID> {
+
+    Optional<NotificationExceptionRecordEntity> findByReferenceAndTaskId(String reference, String taskId);
+}

src/main/java/uk/gov/hmcts/reform/civil/callback/CaseEvent.java

@@ -273,6 +273,7 @@ public enum CaseEvent {
     NOTIFY_CLAIM_SET_ASIDE_JUDGMENT_DEFENDANT1(CAMUNDA),
     NOTIFY_CLAIM_SET_ASIDE_JUDGMENT_DEFENDANT1_LIP(CAMUNDA),
     NOTIFY_CLAIM_SET_ASIDE_JUDGMENT_DEFENDANT2(CAMUNDA),
+    NOTIFY_EVENT(CAMUNDA),
     SEND_SET_ASIDE_JUDGEMENT_IN_ERROR_LETTER_TO_LIP_DEFENDANT1(CAMUNDA),
     POST_JO_DEFENDANT1_PIN_IN_LETTER(CAMUNDA),
     JUDGMENT_BY_ADMISSION_DEFENDANT1_PIN_IN_LETTER(CAMUNDA),

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/camunda/notification/LitigationFriendAddedNotificationHandler.java

@@ -0,0 +1,53 @@
+package uk.gov.hmcts.reform.civil.handler.callback.camunda.notification;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import uk.gov.hmcts.reform.ccd.client.model.AboutToStartOrSubmitCallbackResponse;
+import uk.gov.hmcts.reform.ccd.client.model.CallbackResponse;
+import uk.gov.hmcts.reform.civil.callback.Callback;
+import uk.gov.hmcts.reform.civil.callback.CallbackHandler;
+import uk.gov.hmcts.reform.civil.callback.CallbackParams;
+import uk.gov.hmcts.reform.civil.callback.CaseEvent;
+import uk.gov.hmcts.reform.civil.notification.handlers.AddDefendantLitigationFriendNotifier;
+
+import java.util.List;
+import java.util.Map;
+
+import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
+import static uk.gov.hmcts.reform.civil.callback.CaseEvent.NOTIFY_EVENT;
+
+@Service
+@RequiredArgsConstructor
+@Slf4j
+public class LitigationFriendAddedNotificationHandler extends CallbackHandler {
+
+    private static final List<CaseEvent> EVENTS = List.of(NOTIFY_EVENT);
+
+    public static final String TASK_ID = "LitigationFriendAddedNotifier";
+
+    private final AddDefendantLitigationFriendNotifier addDefendantLitigationFriendNotifier;
+
+    @Override
+    protected Map<String, Callback> callbacks() {
+        return Map.of(
+            callbackKey(ABOUT_TO_SUBMIT), this::notifyForLitigationFriendAdded
+        );
+    }
+
+    @Override
+    public String camundaActivityId(CallbackParams callbackParams) {
+        return TASK_ID;
+    }
+
+    @Override
+    public List<CaseEvent> handledEvents() {
+        return EVENTS;
+    }
+
+    private CallbackResponse notifyForLitigationFriendAdded(CallbackParams callbackParams) {
+        addDefendantLitigationFriendNotifier.notifyParties(callbackParams.getCaseData(), TASK_ID);
+
+        return AboutToStartOrSubmitCallbackResponse.builder().build();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/model/NotificationParty.java

@@ -0,0 +1,8 @@
+package uk.gov.hmcts.reform.civil.model;
+
+public enum NotificationParty {
+    APPLICANT_1,
+    APPLICANT_2,
+    DEFENDANT_1,
+    DEFENDANT_2
+}

src/main/java/uk/gov/hmcts/reform/civil/notification/handlers/AddDefendantLitigationFriendNotifier.java

@@ -0,0 +1,93 @@
+package uk.gov.hmcts.reform.civil.notification.handlers;
+
+import lombok.extern.slf4j.Slf4j;
+import org.jetbrains.annotations.NotNull;
+import org.springframework.stereotype.Component;
+import uk.gov.hmcts.reform.civil.model.CaseData;
+import uk.gov.hmcts.reform.civil.notify.NotificationService;
+import uk.gov.hmcts.reform.civil.notify.NotificationsProperties;
+import uk.gov.hmcts.reform.civil.service.OrganisationService;
+import uk.gov.hmcts.reform.civil.service.flowstate.SimpleStateFlowEngine;
+import uk.gov.hmcts.reform.dashboard.repositories.NotificationExceptionRecordRepository;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import static uk.gov.hmcts.reform.civil.model.NotificationParty.APPLICANT_1;
+import static uk.gov.hmcts.reform.civil.model.NotificationParty.DEFENDANT_1;
+import static uk.gov.hmcts.reform.civil.model.NotificationParty.DEFENDANT_2;
+import static uk.gov.hmcts.reform.civil.service.flowstate.FlowFlag.TWO_RESPONDENT_REPRESENTATIVES;
+import static uk.gov.hmcts.reform.civil.utils.NotificationUtils.buildPartiesReferencesEmailSubject;
+import static uk.gov.hmcts.reform.civil.utils.NotificationUtils.getApplicantLegalOrganizationName;
+import static uk.gov.hmcts.reform.civil.utils.NotificationUtils.getLegalOrganizationNameForRespondent;
+
+@Component
+@Slf4j
+public class AddDefendantLitigationFriendNotifier extends Notifier {
+
+    private static final String REFERENCE_TEMPLATE_APPLICANT = "litigation-friend-added-applicant-notification-%s";
+    private static final String REFERENCE_TEMPLATE_RESPONDENT = "litigation-friend-added-respondent-notification-%s";
+
+    public AddDefendantLitigationFriendNotifier(NotificationService notificationService,
+                                                NotificationsProperties notificationsProperties,
+                                                OrganisationService organisationService,
+                                                SimpleStateFlowEngine stateFlowEngine,
+                                                NotificationExceptionRecordRepository exceptionRecordRepository) {
+        super(notificationService, notificationsProperties, organisationService, stateFlowEngine, exceptionRecordRepository);
+    }
+
+    @Override
+    public Map<String, String> addProperties(CaseData caseData) {
+        return new HashMap<>(Map.of(
+                CLAIM_REFERENCE_NUMBER, caseData.getCcdCaseReference().toString(),
+                PARTY_REFERENCES, buildPartiesReferencesEmailSubject(caseData)
+        ));
+    }
+
+    @Override
+    @NotNull
+    protected Set<EmailDTO> getPartiesToNotify(final CaseData caseData) {
+        Set<EmailDTO> partiesToEmail = new HashSet<>();
+        partiesToEmail.add(getApplicant(caseData));
+        partiesToEmail.addAll(getRespondents(caseData));
+        return partiesToEmail;
+    }
+
+    private EmailDTO getApplicant(CaseData caseData) {
+        Map<String, String> properties = addProperties(caseData);
+        properties.put(CLAIM_LEGAL_ORG_NAME_SPEC, getApplicantLegalOrganizationName(caseData, organisationService));
+        return EmailDTO.builder()
+                .targetEmail(caseData.getApplicantSolicitor1UserDetails().getEmail())
+                .party(APPLICANT_1)
+                .emailTemplate(notificationsProperties.getSolicitorLitigationFriendAdded())
+                .parameters(properties)
+                .reference(String.format(REFERENCE_TEMPLATE_APPLICANT, caseData.getLegacyCaseReference()))
+                .build();
+    }
+
+    private Set<EmailDTO> getRespondents(CaseData caseData) {
+        Set<EmailDTO> recipients = new HashSet<>();
+        recipients.add(getRespondent(caseData, true));
+        if (stateFlowEngine.evaluate(caseData).isFlagSet(TWO_RESPONDENT_REPRESENTATIVES)) {
+            recipients.add(getRespondent(caseData, false));
+        }
+
+        return recipients;
+    }
+
+    private EmailDTO getRespondent(CaseData caseData, boolean isRespondent1) {
+        Map<String, String> properties = addProperties(caseData);
+        properties.put(CLAIM_LEGAL_ORG_NAME_SPEC, getLegalOrganizationNameForRespondent(caseData,
+                isRespondent1, organisationService));
+
+        return EmailDTO.builder()
+                        .targetEmail(isRespondent1 ? caseData.getRespondentSolicitor1EmailAddress() : caseData.getRespondentSolicitor2EmailAddress())
+                        .emailTemplate(notificationsProperties.getSolicitorLitigationFriendAdded())
+                        .parameters(properties)
+                        .party(isRespondent1 ? DEFENDANT_1 : DEFENDANT_2)
+                        .reference(String.format(REFERENCE_TEMPLATE_RESPONDENT, caseData.getLegacyCaseReference()))
+                        .build();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/notification/handlers/EmailDTO.java

@@ -0,0 +1,22 @@
+package uk.gov.hmcts.reform.civil.notification.handlers;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import uk.gov.hmcts.reform.civil.model.NotificationParty;
+
+import java.util.Map;
+
+@Data
+@Builder(toBuilder = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class EmailDTO {
+
+    private String targetEmail;
+    private NotificationParty party;
+    private String emailTemplate;
+    private Map<String, String> parameters;
+    private String reference;
+}