Rename sent/received submission id to inbound/outbound message id variables

etor/src/main/java/gov/hhs/cdc/trustedintermediary/etor/EtorDomainRegistration.java

@@ -153,9 +153,9 @@ public String openApiSpecification() throws UnableToReadOpenApiSpecificationExce
     DomainResponse handleOrders(DomainRequest request) {
         return handleMessageRequest(
                 request,
-                receivedSubmissionId -> {
+                outboundMessageId -> {
                     Order<?> orders = orderController.parseOrders(request);
-                    sendOrderUseCase.convertAndSend(orders, receivedSubmissionId);
+                    sendOrderUseCase.convertAndSend(orders, outboundMessageId);
                     return domainResponseHelper.constructOkResponse(new OrderResponse(orders));
                 },
                 "order");
@@ -164,9 +164,9 @@ DomainResponse handleOrders(DomainRequest request) {
     DomainResponse handleResults(DomainRequest request) {
         return handleMessageRequest(
                 request,
-                receivedSubmissionId -> {
+                outboundMessageId -> {
                     Result<?> results = resultController.parseResults(request);
-                    sendResultUseCase.convertAndSend(results, receivedSubmissionId);
+                    sendResultUseCase.convertAndSend(results, outboundMessageId);
                     return domainResponseHelper.constructOkResponse(new ResultResponse(results));
                 },
                 "results");
@@ -186,8 +186,7 @@ DomainResponse handleMetadata(DomainRequest request) {
             var metadata = metadataOptional.get();
 
             Set<String> messageIdsToLink =
-                    partnerMetadataOrchestrator.findMessagesIdsToLink(
-                            metadata.receivedSubmissionId());
+                    partnerMetadataOrchestrator.findMessagesIdsToLink(metadata.outboundMessageId());
 
             FhirMetadata<?> responseObject =
                     partnerMetadataConverter.extractPublicMetadataToOperationOutcome(
@@ -223,12 +222,12 @@ protected DomainResponse handleMessageRequest(
             DomainRequest request,
             MessageRequestHandler<DomainResponse> requestHandler,
             String messageType) {
-        String receivedSubmissionId = getReceivedSubmissionId(request);
+        String outboundMessageId = getOutboundMessageId(request);
         boolean markMetadataAsFailed = false;
         String errorMessage = "";
 
         try {
-            return requestHandler.handle(receivedSubmissionId);
+            return requestHandler.handle(outboundMessageId);
         } catch (FhirParseException e) {
             errorMessage = "Unable to parse " + messageType + " request";
             logger.logError(errorMessage, e);
@@ -243,21 +242,21 @@ protected DomainResponse handleMessageRequest(
             if (markMetadataAsFailed) {
                 try {
                     partnerMetadataOrchestrator.setMetadataStatusToFailed(
-                            receivedSubmissionId, errorMessage);
+                            outboundMessageId, errorMessage);
                 } catch (PartnerMetadataException innerE) {
                     logger.logError("Unable to update metadata status", innerE);
                 }
             }
         }
     }
 
-    protected String getReceivedSubmissionId(DomainRequest request) {
+    protected String getOutboundMessageId(DomainRequest request) {
 
-        String receivedSubmissionId = request.getHeaders().get("recordid");
-        if (receivedSubmissionId == null || receivedSubmissionId.isEmpty()) {
+        String outboundMessageId = request.getHeaders().get("recordid");
+        if (outboundMessageId == null || outboundMessageId.isEmpty()) {
             logger.logError("Missing required header or empty: RecordId");
             return null;
         }
-        return receivedSubmissionId;
+        return outboundMessageId;
     }
 }

etor/src/main/java/gov/hhs/cdc/trustedintermediary/etor/messages/MessageRequestHandler.java

@@ -12,10 +12,10 @@ public interface MessageRequestHandler<T> {
     /**
      * Parses the request, converts and sends the message
      *
-     * @param receivedSubmissionId the ID for the submission returned from ReportStream
+     * @param outboundMessageId the ID for the submission returned from ReportStream
      * @return the response
      * @throws FhirParseException if there is an error parsing the FHIR data
      * @throws UnableToSendMessageException if there is an error sending the message
      */
-    T handle(String receivedSubmissionId) throws FhirParseException, UnableToSendMessageException;
+    T handle(String outboundMessageId) throws FhirParseException, UnableToSendMessageException;
 }

etor/src/main/java/gov/hhs/cdc/trustedintermediary/etor/messages/SendMessageHelper.java

@@ -22,7 +22,7 @@ public static SendMessageHelper getInstance() {
     private SendMessageHelper() {}
 
     public void savePartnerMetadataForReceivedMessage(PartnerMetadata partnerMetadata) {
-        if (partnerMetadata.receivedSubmissionId() == null) {
+        if (partnerMetadata.outboundMessageId() == null) {
             logger.logWarning(
                     "Received submissionId is null so not saving metadata for received message");
             return;
@@ -31,57 +31,57 @@ public void savePartnerMetadataForReceivedMessage(PartnerMetadata partnerMetadat
             partnerMetadataOrchestrator.updateMetadataForReceivedMessage(partnerMetadata);
         } catch (PartnerMetadataException e) {
             logger.logError(
-                    "Unable to save metadata for receivedSubmissionId "
-                            + partnerMetadata.receivedSubmissionId(),
+                    "Unable to save metadata for outboundMessageId "
+                            + partnerMetadata.outboundMessageId(),
                     e);
         }
     }
 
-    public void saveSentMessageSubmissionId(String receivedSubmissionId, String sentSubmissionId) {
-        if (sentSubmissionId == null || receivedSubmissionId == null) {
+    public void saveSentMessageSubmissionId(String outboundMessageId, String inboundMessageId) {
+        if (inboundMessageId == null || outboundMessageId == null) {
             logger.logWarning(
                     "Received and/or sent submissionId is null so not saving metadata for sent result");
             return;
         }
 
         try {
             partnerMetadataOrchestrator.updateMetadataForSentMessage(
-                    receivedSubmissionId, sentSubmissionId);
+                    outboundMessageId, inboundMessageId);
         } catch (PartnerMetadataException e) {
             logger.logError(
                     "Unable to update metadata for received submissionId "
-                            + receivedSubmissionId
+                            + outboundMessageId
                             + " and sent submissionId "
-                            + sentSubmissionId,
+                            + inboundMessageId,
                     e);
         }
     }
 
-    public void linkMessage(String receivedSubmissionId) {
-        if (receivedSubmissionId == null) {
+    public void linkMessage(String outboundMessageId) {
+        if (outboundMessageId == null) {
             logger.logWarning("Received submissionId is null so not linking messages");
             return;
         }
 
         try {
             Set<String> messageIdsToLink =
-                    partnerMetadataOrchestrator.findMessagesIdsToLink(receivedSubmissionId);
+                    partnerMetadataOrchestrator.findMessagesIdsToLink(outboundMessageId);
 
             if (messageIdsToLink == null || messageIdsToLink.isEmpty()) {
                 return;
             }
 
-            // Add receivedSubmissionId to complete the list of messageIds to link
-            messageIdsToLink.add(receivedSubmissionId);
+            // Add outboundMessageId to complete the list of messageIds to link
+            messageIdsToLink.add(outboundMessageId);
 
             logger.logInfo(
-                    "Found messages to link for receivedSubmissionId {}: {}",
-                    receivedSubmissionId,
+                    "Found messages to link for outboundMessageId {}: {}",
+                    outboundMessageId,
                     messageIdsToLink);
             partnerMetadataOrchestrator.linkMessages(messageIdsToLink);
         } catch (PartnerMetadataException | MessageLinkException e) {
             logger.logError(
-                    "Unable to link messages for received submissionId " + receivedSubmissionId, e);
+                    "Unable to link messages for received submissionId " + outboundMessageId, e);
         }
     }
 }

etor/src/main/java/gov/hhs/cdc/trustedintermediary/etor/metadata/partner/PartnerMetadata.java

@@ -6,16 +6,16 @@
 /**
  * The partner-facing metadata.
  *
- * @param receivedSubmissionId The received submission ID.
- * @param sentSubmissionId The sent submission ID.
+ * @param outboundMessageId The received submission ID.
+ * @param inboundMessageId The inbound submission ID.
  * @param timeReceived The time the message was received.
  * @param timeDelivered The time the message was delivered.
  * @param hash The hash of the message.
  * @param deliveryStatus the status of the message based on an enum
  */
 public record PartnerMetadata(
-        String receivedSubmissionId,
-        String sentSubmissionId,
+        String outboundMessageId,
+        String inboundMessageId,
         Instant timeReceived,
         Instant timeDelivered,
         String hash,
@@ -36,7 +36,7 @@ public record PartnerMetadata(
     }
 
     public PartnerMetadata(
-            String receivedSubmissionId,
+            String outboundMessageId,
             String hash,
             PartnerMetadataMessageType messageType,
             MessageHdDataType sendingApplicationDetails,
@@ -45,7 +45,7 @@ public PartnerMetadata(
             MessageHdDataType receivingFacilityDetails,
             String placerOrderNumber) {
         this(
-                receivedSubmissionId,
+                outboundMessageId,
                 null,
                 null,
                 null,
@@ -60,9 +60,9 @@ public PartnerMetadata(
                 placerOrderNumber);
     }
 
-    public PartnerMetadata(String receivedSubmissionId, PartnerMetadataStatus deliveryStatus) {
+    public PartnerMetadata(String outboundMessageId, PartnerMetadataStatus deliveryStatus) {
         this(
-                receivedSubmissionId,
+                outboundMessageId,
                 null,
                 null,
                 null,
@@ -77,10 +77,10 @@ public PartnerMetadata(String receivedSubmissionId, PartnerMetadataStatus delive
                 null);
     }
 
-    public PartnerMetadata withSentSubmissionId(String sentSubmissionId) {
+    public PartnerMetadata withInboundMessageId(String inboundMessageId) {
         return new PartnerMetadata(
-                this.receivedSubmissionId,
-                sentSubmissionId,
+                this.outboundMessageId,
+                inboundMessageId,
                 this.timeReceived,
                 this.timeDelivered,
                 this.hash,
@@ -96,8 +96,8 @@ public PartnerMetadata withSentSubmissionId(String sentSubmissionId) {
 
     public PartnerMetadata withTimeReceived(Instant timeReceived) {
         return new PartnerMetadata(
-                this.receivedSubmissionId,
-                this.sentSubmissionId,
+                this.outboundMessageId,
+                this.inboundMessageId,
                 timeReceived,
                 this.timeDelivered,
                 this.hash,
@@ -113,8 +113,8 @@ public PartnerMetadata withTimeReceived(Instant timeReceived) {
 
     public PartnerMetadata withTimeDelivered(Instant timeDelivered) {
         return new PartnerMetadata(
-                this.receivedSubmissionId,
-                this.sentSubmissionId,
+                this.outboundMessageId,
+                this.inboundMessageId,
                 this.timeReceived,
                 timeDelivered,
                 this.hash,
@@ -130,8 +130,8 @@ public PartnerMetadata withTimeDelivered(Instant timeDelivered) {
 
     public PartnerMetadata withDeliveryStatus(PartnerMetadataStatus deliveryStatus) {
         return new PartnerMetadata(
-                this.receivedSubmissionId,
-                this.sentSubmissionId,
+                this.outboundMessageId,
+                this.inboundMessageId,
                 this.timeReceived,
                 this.timeDelivered,
                 this.hash,
@@ -147,8 +147,8 @@ public PartnerMetadata withDeliveryStatus(PartnerMetadataStatus deliveryStatus)
 
     public PartnerMetadata withFailureMessage(String failureMessage) {
         return new PartnerMetadata(
-                this.receivedSubmissionId,
-                this.sentSubmissionId,
+                this.outboundMessageId,
+                this.inboundMessageId,
                 this.timeReceived,
                 this.timeDelivered,
                 this.hash,

etor/src/main/java/gov/hhs/cdc/trustedintermediary/etor/metadata/partner/PartnerMetadataOrchestrator.java

@@ -45,15 +45,15 @@ public void updateMetadataForReceivedMessage(PartnerMetadata partnerMetadata)
             throws PartnerMetadataException {
 
         logger.logInfo(
-                "Looking up sender name and timeReceived from RS delivery API for receivedSubmissionId: {}",
-                partnerMetadata.receivedSubmissionId());
+                "Looking up sender name and timeReceived from RS delivery API for outboundMessageId: {}",
+                partnerMetadata.outboundMessageId());
 
         Instant timeReceived;
         try {
             String bearerToken = rsclient.getRsToken();
             String responseBody =
                     rsclient.requestDeliveryEndpoint(
-                            partnerMetadata.receivedSubmissionId(), bearerToken);
+                            partnerMetadata.outboundMessageId(), bearerToken);
             Map<String, Object> responseObject =
                     formatter.convertJsonToObject(responseBody, new TypeReference<>() {});
 
@@ -81,7 +81,7 @@ public void updateMetadataForReceivedMessage(PartnerMetadata partnerMetadata)
             // some data is missing
             logger.logWarning(
                     "Unable to retrieve metadata from RS delivery API, but writing basic metadata entry anyway for received submission ID {}",
-                    partnerMetadata.receivedSubmissionId());
+                    partnerMetadata.outboundMessageId());
             partnerMetadataStorage.saveMetadata(partnerMetadata);
 
             throw new PartnerMetadataException(
@@ -93,55 +93,54 @@ public void updateMetadataForReceivedMessage(PartnerMetadata partnerMetadata)
         partnerMetadataStorage.saveMetadata(updatedPartnerMetadata);
     }
 
-    public void updateMetadataForSentMessage(String receivedSubmissionId, String sentSubmissionId)
+    public void updateMetadataForSentMessage(String outboundMessageId, String inboundMessageId)
             throws PartnerMetadataException {
 
-        if (sentSubmissionId == null) {
+        if (inboundMessageId == null) {
             return;
         }
 
         Optional<PartnerMetadata> optionalPartnerMetadata =
-                partnerMetadataStorage.readMetadata(receivedSubmissionId);
+                partnerMetadataStorage.readMetadata(outboundMessageId);
         if (optionalPartnerMetadata.isEmpty()) {
-            logger.logWarning(
-                    "Metadata not found for receivedSubmissionId: {}", receivedSubmissionId);
+            logger.logWarning("Metadata not found for outboundMessageId: {}", outboundMessageId);
             return;
         }
 
         PartnerMetadata partnerMetadata = optionalPartnerMetadata.get();
 
-        if (sentSubmissionId.equals(partnerMetadata.sentSubmissionId())) {
+        if (inboundMessageId.equals(partnerMetadata.inboundMessageId())) {
             return;
         }
 
-        logger.logInfo("Updating metadata with sentSubmissionId: {}", sentSubmissionId);
-        partnerMetadata = partnerMetadata.withSentSubmissionId(sentSubmissionId);
+        logger.logInfo("Updating metadata with inboundMessageId: {}", inboundMessageId);
+        partnerMetadata = partnerMetadata.withInboundMessageId(inboundMessageId);
         partnerMetadataStorage.saveMetadata(partnerMetadata);
     }
 
-    public Optional<PartnerMetadata> getMetadata(String receivedSubmissionId)
+    public Optional<PartnerMetadata> getMetadata(String outboundMessageId)
             throws PartnerMetadataException {
         Optional<PartnerMetadata> optionalPartnerMetadata =
-                partnerMetadataStorage.readMetadata(receivedSubmissionId);
+                partnerMetadataStorage.readMetadata(outboundMessageId);
         if (optionalPartnerMetadata.isEmpty()) {
-            logger.logInfo("Metadata not found for receivedSubmissionId: {}", receivedSubmissionId);
+            logger.logInfo("Metadata not found for outboundMessageId: {}", outboundMessageId);
             return Optional.empty();
         }
 
         PartnerMetadata partnerMetadata = optionalPartnerMetadata.get();
-        var sentSubmissionId = partnerMetadata.sentSubmissionId();
-        if (metadataIsStale(partnerMetadata) && sentSubmissionId != null) {
+        var inboundMessageId = partnerMetadata.inboundMessageId();
+        if (metadataIsStale(partnerMetadata) && inboundMessageId != null) {
             logger.logInfo(
                     "Receiver name not found in metadata or delivery status still pending, looking up {} from RS history API",
-                    sentSubmissionId);
+                    inboundMessageId);
 
             String rsStatus;
             String rsMessage = "";
             String timeDelivered;
             try {
                 String bearerToken = rsclient.getRsToken();
                 String responseBody =
-                        rsclient.requestHistoryEndpoint(sentSubmissionId, bearerToken);
+                        rsclient.requestHistoryEndpoint(inboundMessageId, bearerToken);
                 var parsedResponseBody = getDataFromReportStream(responseBody);
                 rsStatus = parsedResponseBody[0];
                 rsMessage = parsedResponseBody[1];
@@ -206,7 +205,7 @@ public Map<String, Map<String, Object>> getConsolidatedMetadata(String senderNam
         return metadataSet.stream()
                 .collect(
                         Collectors.toMap(
-                                PartnerMetadata::receivedSubmissionId,
+                                PartnerMetadata::outboundMessageId,
                                 metadata -> {
                                     var status = String.valueOf(metadata.deliveryStatus());
                                     var stale = metadataIsStale(metadata);
@@ -221,10 +220,10 @@ public Map<String, Map<String, Object>> getConsolidatedMetadata(String senderNam
                                 }));
     }
 
-    public Set<String> findMessagesIdsToLink(String receivedSubmissionId)
+    public Set<String> findMessagesIdsToLink(String outboundMessageId)
             throws PartnerMetadataException {
 
-        return partnerMetadataStorage.readMetadataForMessageLinking(receivedSubmissionId);
+        return partnerMetadataStorage.readMetadataForMessageLinking(outboundMessageId);
     }
 
     public void linkMessages(Set<String> messageIds) throws MessageLinkException {