NgSurvey integration (#13885)

Introduces an end-to-end pipeline that lets an external survey tool (ngSurvey) push answer payloads back into SORMAS and have them turned into a CaseDataDto patch.

Feature is broken down into following layers:

- API layer (sormas-api): new DTOs/facades for external survey messages, a DataPatcher contract, a PartialRetriever contract, plus mapping/alias support.
- Backend (sormas-backend.patch) - an in-house mini-framework on top of Apache Commons PropertyUtils:
        DataPatcherImpl orchestrates per-field patching with a result-collecting pipeline.
        PartialRetrieverImpl reads back the same paths for display.
        Pluggable ValuePatchMapper (date / enum / customizable enum / primitive / reference DTO) andFieldCustomMapper (person contact details, person birthdate) registries.
        EqualityChecker registry used when DataReplacementStrategy.IF_NOT_ALREADY_PRESENT.
        PathAliasHelper lets external systems address fields by their Field ID (see: SORMAS Data Dictionary) instead of the full DTO path (e.g. Symptoms.fever instead of CaseData.symptoms.fever).
    Survey integration (sormas-backend.externalmessage.survey) - AutomaticSurveyResponseProcessor consumes ExternalMessageDtos, resolves the SurveyToken, and feeds the DataPatcher.
    UI: new views/forms for survey/token management and survey-response details.

The core abstraction (path-based patcher with pluggable mappers, validators and aliases) is reusable beyond ngSurvey.

Fixes #13832

Author: Pa-Touche

sormas-api/src/main/java/de/symeda/sormas/api/Disease.java

@@ -17,6 +17,10 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import com.google.common.collect.ImmutableSet;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
 import de.symeda.sormas.api.statistics.StatisticsGroupingKey;
@@ -94,6 +98,12 @@ public enum Disease
 	OTHER(true, true, true, false, true, 21, false, false, false, false, 0, 0),
 	UNDEFINED(true, true, true, false, true, 0, false, false, false, false, 0, 0);
 
+	/**
+	 * Immutable that eager loads all available diseases.
+	 */
+	public static final Set<Disease> ALL_DISEASES =
+		Arrays.stream(Disease.values()).collect(Collectors.collectingAndThen(Collectors.toSet(), ImmutableSet::copyOf));
+
 	private final boolean defaultActive;
 	private final boolean defaultPrimary;
 	private final boolean defaultCaseSurveillanceEnabled;

sormas-api/src/main/java/de/symeda/sormas/api/FacadeProvider.java

@@ -109,6 +109,7 @@
 import de.symeda.sormas.api.specialcaseaccess.SpecialCaseAccessFacade;
 import de.symeda.sormas.api.survey.SurveyFacade;
 import de.symeda.sormas.api.survey.SurveyTokenFacade;
+import de.symeda.sormas.api.survey.alias.PathAliasFacade;
 import de.symeda.sormas.api.symptoms.SymptomsFacade;
 import de.symeda.sormas.api.systemconfiguration.SystemConfigurationCategoryFacade;
 import de.symeda.sormas.api.systemconfiguration.SystemConfigurationValueFacade;
@@ -319,6 +320,10 @@ public static PrescriptionFacade getPrescriptionFacade() {
 		return get().lookupEjbRemote(PrescriptionFacade.class);
 	}
 
+	public static PathAliasFacade getPathAliasFacade() {
+		return get().lookupEjbRemote(PathAliasFacade.class);
+	}
+
 	public static TreatmentFacade getTreatmentFacade() {
 		return get().lookupEjbRemote(TreatmentFacade.class);
 	}

sormas-api/src/main/java/de/symeda/sormas/api/ResourceBundle.java

@@ -26,4 +26,8 @@ public String getString(String key, String defaultValue) {
 	public String getString(String key) {
 		return getString(key, null);
 	}
+
+	public java.util.ResourceBundle getResourceBundle() {
+		return resourceBundle;
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/caze/InfectionSetting.java

@@ -16,9 +16,11 @@
 package de.symeda.sormas.api.caze;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.patch.mapping.ValueMapperDefault;
 
 public enum InfectionSetting {
 
+	@ValueMapperDefault
 	UNKNOWN(null),
 	AMBULATORY(null),
 	MEDICAL_PRACTICE(AMBULATORY),

sormas-api/src/main/java/de/symeda/sormas/api/caze/QuarantineReason.java

@@ -16,13 +16,15 @@
 package de.symeda.sormas.api.caze;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.patch.mapping.ValueMapperDefault;
 
 public enum QuarantineReason {
 
 	IDENTIFIED_BY_CONTACT_TRACING,
 	ENTRY_FROM_RISK_AREA,
 	SWISS_COVID_APP_NOTIFICATION,
 	OUTBREAK_INVESTIGATION,
+	@ValueMapperDefault
 	OTHER_REASON;
 
 	@Override

sormas-api/src/main/java/de/symeda/sormas/api/caze/Trimester.java

@@ -1,12 +1,14 @@
 package de.symeda.sormas.api.caze;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.patch.mapping.ValueMapperDefault;
 
 public enum Trimester {
 
 	FIRST,
 	SECOND,
 	THIRD,
+	@ValueMapperDefault
 	UNKNOWN;
 
 	@Override

sormas-api/src/main/java/de/symeda/sormas/api/clinicalcourse/HealthConditionsDto.java

@@ -84,6 +84,8 @@ public class HealthConditionsDto extends PseudonymizableDto {
 	private YesNoUnknown hivArt;
 	private YesNoUnknown chronicLiverDisease;
 	private YesNoUnknown malignancyChemotherapy;
+
+	//TODO: rename ? general heart issue
 	@HideForCountries(countries = {
 		CountryHelper.COUNTRY_CODE_GERMANY,
 		CountryHelper.COUNTRY_CODE_SWITZERLAND })

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/ExternalMessageDto.java

@@ -19,6 +19,7 @@
 import java.util.Date;
 import java.util.List;
 
+import javax.annotation.Nullable;
 import javax.validation.constraints.Size;
 
 import de.symeda.sormas.api.CountryHelper;
@@ -33,6 +34,7 @@
 import de.symeda.sormas.api.disease.DiseaseVariant;
 import de.symeda.sormas.api.exposure.ModeOfTransmission;
 import de.symeda.sormas.api.externalmessage.labmessage.SampleReportDto;
+import de.symeda.sormas.api.externalmessage.survey.ExternalSurveyResponseData;
 import de.symeda.sormas.api.feature.FeatureType;
 import de.symeda.sormas.api.i18n.Validations;
 import de.symeda.sormas.api.infrastructure.country.CountryReferenceDto;
@@ -206,6 +208,10 @@ public class ExternalMessageDto extends SormasToSormasShareableDto {
 	private String externalMessageDetails;
 	@Size(max = FieldConstraints.CHARACTER_LIMIT_TEXT, message = Validations.textTooLong)
 	private String caseComments;
+
+	/**
+	 * Used as deduplication key for {@link ExternalMessageType#SURVEY_RESPONSE}.
+	 */
 	@Size(max = FieldConstraints.CHARACTER_LIMIT_DEFAULT, message = Validations.textTooLong)
 	private String reportId;
 
@@ -279,6 +285,12 @@ public class ExternalMessageDto extends SormasToSormasShareableDto {
 	private ModeOfTransmission modeOfTransmission;
 	private String modeOfTransmissionType;
 
+	/**
+	 * Will only be present for: {@link ExternalMessageType#SURVEY_RESPONSE} to represent the pair.
+	 */
+	@Nullable
+	private ExternalSurveyResponseData surveyResponseData;
+
 	public ExternalMessageType getType() {
 		return type;
 	}
@@ -1020,4 +1032,14 @@ public String getModeOfTransmissionType() {
 	public void setModeOfTransmissionType(String modeOfTransmissionType) {
 		this.modeOfTransmissionType = modeOfTransmissionType;
 	}
+
+	@Nullable
+	public ExternalSurveyResponseData getSurveyResponseData() {
+		return surveyResponseData;
+	}
+
+	public ExternalMessageDto setSurveyResponseData(@Nullable ExternalSurveyResponseData surveyResponseData) {
+		this.surveyResponseData = surveyResponseData;
+		return this;
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/ExternalMessageFacade.java

@@ -2,7 +2,9 @@
 
 import java.util.Date;
 import java.util.List;
+import java.util.Map;
 
+import javax.annotation.Nullable;
 import javax.ejb.Remote;
 import javax.naming.NamingException;
 import javax.validation.Valid;
@@ -11,6 +13,7 @@
 import de.symeda.sormas.api.ReferenceDto;
 import de.symeda.sormas.api.caze.surveillancereport.SurveillanceReportReferenceDto;
 import de.symeda.sormas.api.common.Page;
+import de.symeda.sormas.api.patch.partial_retrieval.DisplayablePartialRetrievalResponse;
 import de.symeda.sormas.api.sample.SampleReferenceDto;
 import de.symeda.sormas.api.user.UserReferenceDto;
 import de.symeda.sormas.api.utils.SortProperty;
@@ -22,6 +25,19 @@ public interface ExternalMessageFacade extends PermanentlyDeletableFacade {
 
 	ExternalMessageDto saveAndProcessLabmessage(@Valid ExternalMessageDto dto);
 
+	/**
+	 * Will attempt to fetch and refresh.
+	 * 
+	 * @param since
+	 *            if not specified
+	 * @return external messages that have been saved.
+	 */
+	List<ExternalMessageDto> saveAndProcessSurveyResponses(@Nullable Date since);
+
+	default List<ExternalMessageDto> saveAndProcessSurveyResponses() {
+		return saveAndProcessSurveyResponses(null);
+	}
+
 	void validate(ExternalMessageDto dto);
 
 	// Also returns deleted lab messages
@@ -70,4 +86,25 @@ public interface ExternalMessageFacade extends PermanentlyDeletableFacade {
 	boolean existsForwardedExternalMessageWith(String reportId);
 
 	ExternalMessageDto getForSurveillanceReport(SurveillanceReportReferenceDto surveillanceReport);
+
+	/**
+	 * Re-submits a survey response with a corrected patch dictionary after previous processing failures.
+	 *
+	 * @param uuid
+	 *            UUID of the external message (must be of type SURVEY_RESPONSE)
+	 * @param correctedDictionary
+	 *            the corrected field path -> value map to apply
+	 * @return updated ExternalMessageDto after reprocessing
+	 */
+	ExternalMessageDto overwriteSurveyResponse(String uuid, Map<String, Object> correctedDictionary);
+
+	/**
+	 * Retrieves display-ready field information (translated names and current case values) for all fields
+	 * in the survey response patch dictionary. Used by the UI to render the detail/editor windows.
+	 *
+	 * @param externalMessageUuid
+	 *            UUID of the external message (must be of type SURVEY_RESPONSE with a processed result)
+	 * @return displayable field info keyed by field path
+	 */
+	DisplayablePartialRetrievalResponse fetchSurveyResponseFieldsForDisplay(String externalMessageUuid);
 }

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/ExternalMessageType.java

@@ -5,7 +5,8 @@
 public enum ExternalMessageType {
 
 	LAB_MESSAGE,
-	PHYSICIANS_REPORT;
+	PHYSICIANS_REPORT,
+	SURVEY_RESPONSE;
 
 	@Override
 	public String toString() {