feat: P4ADEV-1545 fdr ingestion actity implementation retrieval via query file validation

src/main/java/it/gov/pagopa/payhub/activities/activity/fdr/UpdateIngestionFlowStatusActivity.java → src/main/java/it/gov/pagopa/payhub/activities/activity/ingestionflow/UpdateIngestionFlowStatusActivity.java

@@ -1,4 +1,4 @@
-package it.gov.pagopa.payhub.activities.activity.fdr;
+package it.gov.pagopa.payhub.activities.activity.ingestionflow;
 
 /**
  * Interface for the UpdateIngestionFlowStatusActivity.

src/main/java/it/gov/pagopa/payhub/activities/activity/paymentsreporting/ReportingFlowIngestionActivity.java

@@ -0,0 +1,17 @@
+package it.gov.pagopa.payhub.activities.activity.paymentsreporting;
+import it.gov.pagopa.payhub.activities.dto.reportingflow.ReportingFlowIngestionActivityResult;
+
+/**
+ * Interface for the ReportingFlowIngestionActivity.
+ * Defines methods for processing files based on an IngestionFlow ID.
+ */
+public interface ReportingFlowIngestionActivity {
+
+    /**
+     * Processes a file based on the provided IngestionFlow ID.
+     *
+     * @param ingestionFlowId the unique identifier related to the file to process.
+     * @return {@link ReportingFlowIngestionActivityResult} containing the list of IUFs and status.
+     */
+    ReportingFlowIngestionActivityResult processFile(String ingestionFlowId);
+}

src/main/java/it/gov/pagopa/payhub/activities/activity/paymentsreporting/ReportingFlowIngestionActivityImpl.java

@@ -0,0 +1,56 @@
+package it.gov.pagopa.payhub.activities.activity.paymentsreporting;
+
+import it.gov.pagopa.payhub.activities.service.ingestionflow.IngestionFileHandlerService;
+import it.gov.pagopa.payhub.activities.service.ingestionflow.IngestionFlowRetrieverService;
+import it.gov.pagopa.payhub.activities.dto.reportingflow.ReportingFlowIngestionActivityResult;
+import it.gov.pagopa.payhub.activities.dto.ingestionflow.IngestionFlowDTO;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Implementation of the `ReportingFlowIngestionActivity` interface.
+ * Manages the ingestion of reporting flow files, including validation and processing.
+ */
+@Slf4j
+@Component
+public class ReportingFlowIngestionActivityImpl implements ReportingFlowIngestionActivity {
+	private final IngestionFlowRetrieverService ingestionFlowRetrieverService;
+	private final IngestionFileHandlerService ingestionFileHandlerService;
+
+	/**
+	 * Constructor for `ReportingFlowIngestionActivityImpl`.
+	 *
+	 * @param ingestionFlowRetrieverService service for retrieving ingestion flow details.
+	 * @param ingestionFileHandlerService service for handling ingestion files.
+	 */
+	public ReportingFlowIngestionActivityImpl(IngestionFlowRetrieverService ingestionFlowRetrieverService,
+	                                          IngestionFileHandlerService ingestionFileHandlerService) {
+		this.ingestionFlowRetrieverService = ingestionFlowRetrieverService;
+		this.ingestionFileHandlerService = ingestionFileHandlerService;
+	}
+
+	/**
+	 * Processes an ingestion flow file.
+	 *
+	 * @param ingestionFlowId the ID of the ingestion flow to process.
+	 * @return the result of the ingestion activity, including status and processed items.
+	 */
+	@Override
+	public ReportingFlowIngestionActivityResult processFile(String ingestionFlowId) {
+		List<String> iufList = new ArrayList<>();
+		boolean success = true;
+
+		try {
+			IngestionFlowDTO ingestionFlowDTO = ingestionFlowRetrieverService.getIngestionFlow(Long.valueOf(ingestionFlowId));
+			ingestionFileHandlerService.setUpProcess(ingestionFlowDTO.getFilePathName(), ingestionFlowDTO.getFileName());
+
+		} catch (Exception e) {
+			log.error("Error during IngestionActivity flowId {} due to: {}", ingestionFlowId, e.getMessage());
+			success = false;
+		}
+		return new ReportingFlowIngestionActivityResult(iufList, success);
+	}
+}

src/main/java/it/gov/pagopa/payhub/activities/activity/fdr/SendEmailIngestionFlowActivity.java → src/main/java/it/gov/pagopa/payhub/activities/activity/utility/SendEmailIngestionFlowActivity.java

@@ -1,4 +1,4 @@
-package it.gov.pagopa.payhub.activities.activity.fdr;
+package it.gov.pagopa.payhub.activities.activity.utility;
 
 /**
  * Interface for SendEmailIngestionFlowActivity.

src/main/java/it/gov/pagopa/payhub/activities/dao/IngestionFlowDao.java

@@ -0,0 +1,63 @@
+package it.gov.pagopa.payhub.activities.dao;
+
+import it.gov.pagopa.payhub.activities.dto.ingestionflow.IngestionFlowDTO;
+
+import java.util.Optional;
+
+/**
+ * Data Access Object (DAO) interface for managing ingestion flows.
+ *
+ * <p>
+ * The {@code IngestionFlowDao} provides an abstraction for accessing and manipulating
+ * ingestion flow data. It focuses on retrieving ingestion flow details from the underlying
+ * data source using defined operations.
+ * </p>
+ *
+ * <h2>Purpose</h2>
+ * The interface enables the separation of the data access layer from the business logic layer,
+ * promoting modularity and testability. It is commonly implemented by a class that interacts
+ * with a database or other persistent storage mechanism.
+ *
+ * <h2>Method Details</h2>
+ * <ul>
+ *   <li>
+ *     <strong>{@code getIngestionFlow(Long ingestionFlowId)}</strong>:
+ *     Fetches an {@link IngestionFlowDTO} entity using its unique identifier.
+ *     <ul>
+ *       <li>Parameter: {@code ingestionFlowId} - The unique ID of the ingestion flow to retrieve.</li>
+ *       <li>Returns: {@code Optional<IngestionFlowDTO>} - An optional containing the ingestion flow data, or empty if not found.</li>
+ *     </ul>
+ *   </li>
+ * </ul>
+ *
+ * <h2>Key Features</h2>
+ * <ul>
+ *   <li>Defines a clear contract for ingestion flow data retrieval.</li>
+ *   <li>Supports returning results in an {@link Optional} to handle absent data gracefully.</li>
+ *   <li>Encourages a clean and maintainable design in data access operations.</li>
+ * </ul>
+ *
+ * <h2>Usage Example</h2>
+ * <pre>{@code
+ * // Assuming IngestionFlowDao is implemented by a class IngestionFlowDaoImpl
+ * IngestionFlowDao ingestionFlowDao = new IngestionFlowDaoImpl();
+ * Long ingestionFlowId = 123L;
+ * Optional<IngestionFlowDTO> flow = ingestionFlowDao.getIngestionFlow(ingestionFlowId);
+ *
+ * flow.ifPresent(f -> System.out.println("Ingestion Flow Retrieved: " + f));
+ * }</pre>
+ *
+ * @see IngestionFlowDTO
+ */
+public interface IngestionFlowDao {
+
+	/**
+	 * Retrieves the {@link IngestionFlowDTO} entity based on the provided ingestion flow ID.
+	 *
+	 * @param ingestionFlowId the unique identifier of the ingestion flow to be retrieved.
+	 * @return an {@link Optional} containing the requested {@link IngestionFlowDTO} if found,
+	 *         or an empty {@link Optional} if no matching entity exists.
+	 */
+	Optional<IngestionFlowDTO> getIngestionFlow(Long ingestionFlowId);
+}
+

src/main/java/it/gov/pagopa/payhub/activities/dto/ingestionflow/IngestionFlowDTO.java

@@ -0,0 +1,94 @@
+package it.gov.pagopa.payhub.activities.dto.ingestionflow;
+
+import it.gov.pagopa.payhub.activities.dto.OrganizationDTO;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.sql.Timestamp;
+
+/**
+ * Data Transfer Object (DTO) representing the details of an ingestion flow.
+ *
+ * <p>
+ * This class encapsulates metadata and operational details about an ingestion flow,
+ * serving as a structured data container for various application layers such as
+ * service, controller, or repository layers.
+ * </p>
+ *
+ * <h2>Purpose</h2>
+ * The {@code IngestionFlowDTO} provides a standardized way to transfer and manipulate
+ * information about ingestion flows, which may include details such as the flow's
+ * identifier, organization, type, timestamps, status, and other relevant metadata.
+ *
+ * <h2>Annotations</h2>
+ * <ul>
+ *   <li>{@link lombok.Data} - Generates getter, setter, equals, hashCode, and toString methods.</li>
+ *   <li>{@link lombok.Builder} - Enables the builder pattern for object creation.</li>
+ *   <li>{@link lombok.NoArgsConstructor} - Generates a no-arguments constructor.</li>
+ *   <li>{@link lombok.AllArgsConstructor} - Generates an all-arguments constructor.</li>
+ * </ul>
+ *
+ * <h2>Fields</h2>
+ * <ul>
+ *   <li><strong>ingestionFlowId</strong>: Unique identifier of the ingestion flow.</li>
+ *   <li><strong>version</strong>: Version number of the ingestion flow.</li>
+ *   <li><strong>orgId</strong>: The {@link OrganizationDTO} associated with the ingestion flow.</li>
+ *   <li><strong>PspIdentifier</strong>: Identifier of the Payment Service Provider (PSP) involved.</li>
+ *   <li><strong>flowIdentifierCode</strong>: Code uniquely identifying the ingestion flow.</li>
+ *   <li><strong>flowDateTime</strong>: Timestamp of when the ingestion flow occurred.</li>
+ *   <li><strong>flowType</strong>: Type/category of the ingestion flow.</li>
+ *   <li><strong>flowTypeCode</strong>: Code representing the type of the flow.</li>
+ *   <li><strong>operatorName</strong>: Name of the operator managing the ingestion flow.</li>
+ *   <li><strong>status</strong>: Current status of the ingestion flow (e.g., completed, pending).</li>
+ *   <li><strong>filePathName</strong>: Full path of the file associated with the ingestion flow.</li>
+ *   <li><strong>fileName</strong>: Name of the file associated with the ingestion flow.</li>
+ *   <li><strong>downloadedFileSize</strong>: Size of the file in bytes.</li>
+ *   <li><strong>requestTokenCode</strong>: Token code for the request associated with the ingestion flow.</li>
+ *   <li><strong>creationDate</strong>: Timestamp indicating when the ingestion flow was created.</li>
+ *   <li><strong>lastChangeDate</strong>: Timestamp of the last modification to the ingestion flow.</li>
+ *   <li><strong>fileSourceCode</strong>: Code indicating the source of the file.</li>
+ *   <li><strong>descriptionFileNameScraps</strong>: Additional description or scraps from the file name.</li>
+ *   <li><strong>errorCode</strong>: Code representing any errors encountered during the ingestion process.</li>
+ *   <li><strong>TotalRowsNumber</strong>: Total number of rows in the file.</li>
+ *   <li><strong>numberLinesImportedCorrectly</strong>: Number of rows successfully imported.</li>
+ * </ul>
+ *
+ * <h2>Key Features</h2>
+ * <ul>
+ *   <li>Comprehensive metadata representation for ingestion flows.</li>
+ *   <li>Integration with other DTOs, such as {@link OrganizationDTO}, for structured relationships.</li>
+ *   <li>Leveraging Lombok annotations for concise and maintainable code.</li>
+ * </ul>
+ *
+ * @see OrganizationDTO
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class IngestionFlowDTO {
+	private Long ingestionFlowId;
+	private int version;
+	private OrganizationDTO orgId;
+	private String PspIdentifier;
+	private String flowIdentifierCode;
+	private Timestamp flowDateTime;
+	private String flowType;
+	private String flowTypeCode;
+	private String operatorName;
+	private String status;
+	private String filePathName;
+	private String fileName;
+	private Long downloadedFileSize;
+	private String requestTokenCode;
+	private Timestamp creationDate;
+	private Timestamp lastChangeDate;
+	private String fileSourceCode;
+	private String descriptionFileNameScraps;
+	private String errorCode;
+	private Long TotalRowsNumber;
+	private Long numberLinesImportedCorrectly;
+}
+

src/main/java/it/gov/pagopa/payhub/activities/dto/fdr/FdRIngestionActivityResult.java → src/main/java/it/gov/pagopa/payhub/activities/dto/reportingflow/ReportingFlowIngestionActivityResult.java

@@ -1,4 +1,4 @@
-package it.gov.pagopa.payhub.activities.dto.fdr;
+package it.gov.pagopa.payhub.activities.dto.reportingflow;
 
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -12,7 +12,7 @@
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class FdRIngestionActivityResult {
+public class ReportingFlowIngestionActivityResult {
     /** List of extracted IUFs */
     private List<String> iufs;
     /** Success flag for the operation */

src/main/java/it/gov/pagopa/payhub/activities/exception/ActivitiesException.java

@@ -1,7 +1,38 @@
 package it.gov.pagopa.payhub.activities.exception;
 
+/**
+ * A custom exception that represents errors related to activities within an application.
+ * This exception extends {@link RuntimeException}, allowing it to be thrown during runtime
+ * without requiring explicit declaration in the method signature.
+ *
+ * <p>
+ * The {@code ActivitiesException} is designed to provide a meaningful message about
+ * what caused the exception, helping developers to debug and understand issues in the
+ * activity processing flow.
+ * </p>
+ *
+ * <h2>Usage</h2>
+ * <pre>{@code
+ * if (someConditionFails) {
+ *     throw new ActivitiesException("Activity failed due to some condition.");
+ * }
+ * }</pre>
+ *
+ * <h2>Key Features</h2>
+ * <ul>
+ *   <li>Extends {@code RuntimeException} for unchecked exception behavior.</li>
+ *   <li>Accepts a detailed message to describe the nature of the error.</li>
+ * </ul>
+ *
+ * @see RuntimeException
+ */
 public class ActivitiesException extends RuntimeException {
 
+    /**
+     * Constructs a new {@code ActivitiesException} with the specified detail message.
+     *
+     * @param message the detail message explaining the cause of the exception.
+     */
     public ActivitiesException(String message) {
         super(message);
     }

src/main/java/it/gov/pagopa/payhub/activities/exception/IngestionFlowNotFoundException.java

@@ -0,0 +1,49 @@
+package it.gov.pagopa.payhub.activities.exception;
+
+/**
+ * A custom exception that indicates the absence of an expected ingestion flow
+ * in the application's processing logic.
+ *
+ * <p>
+ * This exception extends {@link ActivitiesException}, providing a more specific
+ * exception type within the activities-related exception hierarchy.
+ * </p>
+ *
+ * <h2>Purpose</h2>
+ * The {@code IngestionFlowNotFoundException} is thrown when an ingestion flow,
+ * identified by a specific parameter (e.g., name, ID, or type), cannot be found.
+ * This can occur in scenarios such as:
+ * <ul>
+ *   <li>An unregistered or undefined ingestion flow being accessed.</li>
+ *   <li>A misconfiguration in the application's ingestion flow definitions.</li>
+ * </ul>
+ *
+ * <h2>Usage</h2>
+ * <pre>{@code
+ * String flowId = "flow123";
+ * if (!ingestionFlowExists(flowId)) {
+ *     throw new IngestionFlowNotFoundException("Ingestion flow not found: " + flowId);
+ * }
+ * }</pre>
+ *
+ * <h2>Key Features</h2>
+ * <ul>
+ *   <li>Extends {@link ActivitiesException}, allowing it to integrate seamlessly into the
+ *       application's exception-handling framework for activity-related errors.</li>
+ *   <li>Accepts a detailed message to describe the nature and context of the error.</li>
+ * </ul>
+ *
+ * @see ActivitiesException
+ */
+public class IngestionFlowNotFoundException extends ActivitiesException {
+
+	/**
+	 * Constructs a new {@code IngestionFlowNotFoundException} with the specified detail message.
+	 *
+	 * @param message the detail message explaining the cause of the exception.
+	 */
+	public IngestionFlowNotFoundException(String message) {
+		super(message);
+	}
+}
+