Add server endpoint for submitting a batch message

processMessage returns a single message id, taken from the response
handler's selected result. For a batch that is only the first or last
message, leaving a caller no way to learn the ids of the others. The
smoke test harness needs them to assert per-message content.

POST /channels/{channelId}/batchMessagesWithObj returns every id. The
response handler is already threaded through dispatchBatchMessage, so
CollectingResponseHandler only has to record each id as it is set. It
keeps the ids and not the DispatchResults, so a long batch does not
retain the processed messages, maps and content of the messages that
have already finished.

Processing is unchanged. Whether a batch is split is still governed by
the channel's Process Batch setting; on a channel with batch processing
disabled the dispatch takes the single-message path and the endpoint
returns a one-element list.

EngineController.dispatchRawMessage gains a five-argument overload. The
existing four-argument form delegates to it with a SimpleResponseHandler,
so its callers are unaffected, but the interface gains an abstract method
and out-of-tree implementations will need updating.

Signed-off-by: Mitch Gaffigan <mitch.gaffigan@comcast.net>

Author: mgaffigan

donkey/src/main/java/com/mirth/connect/donkey/server/message/batch/CollectingResponseHandler.java

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MPL-2.0
+// SPDX-FileCopyrightText: Mitch Gaffigan <mitch@gaffigan.net>
+
+package com.mirth.connect.donkey.server.message.batch;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.mirth.connect.donkey.server.channel.DispatchResult;
+
+/**
+ * Reports every message of a batch, where {@link ResponseHandler#getResultForResponse()} reports
+ * only the one selected for the response.
+ */
+public class CollectingResponseHandler extends SimpleResponseHandler {
+
+    private final List<Long> messageIds = new ArrayList<Long>();
+
+    @Override
+    public void setDispatchResult(DispatchResult dispatchResult) {
+        super.setDispatchResult(dispatchResult);
+
+        if (dispatchResult != null) {
+            messageIds.add(dispatchResult.getMessageId());
+        }
+    }
+
+    public List<Long> getMessageIds() {
+        return messageIds;
+    }
+
+}

server/src/main/java/com/mirth/connect/client/core/Client.java

@@ -1785,6 +1785,16 @@ public Long processMessage(String channelId, RawMessage rawMessage) throws Clien
         return getServlet(MessageServletInterface.class).processMessage(channelId, rawMessage);
     }
 
+    /**
+     * Processes a new message through a channel, returning the ID of every message it produced.
+     * 
+     * @see MessageServletInterface#processBatchMessage
+     */
+    @Override
+    public List<Long> processBatchMessage(String channelId, RawMessage rawMessage) throws ClientException {
+        return getServlet(MessageServletInterface.class).processBatchMessage(channelId, rawMessage);
+    }
+
     /**
      * Processes a new message through a channel, using the RawMessage object.
      * 

server/src/main/java/com/mirth/connect/client/core/api/servlets/MessageServletInterface.java

@@ -97,6 +97,19 @@ public Long processMessage(// @formatter:off
                             @ExampleObject(name = "rawMessage", ref = "../apiexamples/raw_message_json") }) }) RawMessage rawMessage) throws ClientException;
     // @formatter:on
 
+    @POST
+    @Path("/{channelId}/batchMessagesWithObj")
+    @Operation(summary = "Processes a new message through a channel, returning the ID of every message it produced.")
+    @MirthOperation(name = "processMessages", display = "Process messages", permission = Permissions.MESSAGES_PROCESS, type = ExecuteType.ASYNC)
+    public List<Long> processBatchMessage(// @formatter:off
+            @Param("channelId") @Parameter(description = "The ID of the channel.", required = true) @PathParam("channelId") String channelId,
+            @Param("rawMessage") @RequestBody(description = "The RawMessage object to process.", required = true, content = {
+                    @Content(mediaType = MediaType.APPLICATION_XML, examples = {
+                            @ExampleObject(name = "rawMessage", ref = "../apiexamples/raw_message_xml") }),
+                    @Content(mediaType = MediaType.APPLICATION_JSON, examples = {
+                            @ExampleObject(name = "rawMessage", ref = "../apiexamples/raw_message_json") }) }) RawMessage rawMessage) throws ClientException;
+    // @formatter:on
+
     @GET
     @Path("/{channelId}/messages/{messageId}")
     @Operation(summary = "Retrieve a message by ID.")

server/src/main/java/com/mirth/connect/server/api/servlets/MessageServlet.java

@@ -45,6 +45,7 @@
 import com.mirth.connect.donkey.server.channel.ChannelException;
 import com.mirth.connect.donkey.server.channel.DispatchResult;
 import com.mirth.connect.donkey.server.message.batch.BatchMessageException;
+import com.mirth.connect.donkey.server.message.batch.CollectingResponseHandler;
 import com.mirth.connect.model.MessageImportResult;
 import com.mirth.connect.model.ServerEvent;
 import com.mirth.connect.model.ServerEvent.Level;
@@ -133,6 +134,27 @@ public Long processMessage(final String channelId, final RawMessage rawMessage)
         return null;
     }
 
+    @Override
+    @CheckAuthorizedChannelId
+    public List<Long> processBatchMessage(final String channelId, final RawMessage rawMessage) {
+        CollectingResponseHandler responseHandler = new CollectingResponseHandler();
+
+        try {
+            engineController.dispatchRawMessage(channelId, rawMessage, true, true, responseHandler);
+
+            containerRequestContext.setProperty(ResponseCodeFilter.RESPONSE_CODE_PROPERTY, Response.Status.CREATED.getStatusCode());
+            return responseHandler.getMessageIds();
+        } catch (ChannelException e) {
+            // Do nothing. An error should have been logged.
+        } catch (BatchMessageException e) {
+            logger.error("Error processing batch message for channel " + channelId, e);
+        }
+
+        containerRequestContext.setProperty(ResponseCodeFilter.RESPONSE_CODE_PROPERTY, Response.Status.INTERNAL_SERVER_ERROR.getStatusCode());
+
+        return null;
+    }
+
     @Override
     @CheckAuthorizedChannelId
     public Message getMessageContent(String channelId, Long messageId, List<Integer> metaDataIds) {

server/src/main/java/com/mirth/connect/server/controllers/DonkeyEngineController.java

@@ -1119,6 +1119,11 @@ public Channel getDeployedChannel(String channelId) {
 
     @Override
     public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage, boolean force, boolean canBatch) throws ChannelException, BatchMessageException {
+        return dispatchRawMessage(channelId, rawMessage, force, canBatch, new SimpleResponseHandler());
+    }
+
+    @Override
+    public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage, boolean force, boolean canBatch, ResponseHandler responseHandler) throws ChannelException, BatchMessageException {
         if (!isDeployed(channelId)) {
             ChannelException e = new ChannelException(true);
             logger.error("Could not find channel to route to: " + channelId, e);
@@ -1133,7 +1138,6 @@ public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage
             } else {
                 BatchRawMessage batchRawMessage = new BatchRawMessage(new BatchMessageReader(rawMessage.getRawData()), rawMessage.getSourceMap());
 
-                ResponseHandler responseHandler = new SimpleResponseHandler();
                 sourceConnector.dispatchBatchMessage(batchRawMessage, responseHandler, rawMessage.getDestinationMetaDataIds());
 
                 return responseHandler.getResultForResponse();
@@ -1144,6 +1148,7 @@ public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage
             try {
                 dispatchResult = sourceConnector.dispatchRawMessage(rawMessage, force);
                 dispatchResult.setAttemptedResponse(true);
+                responseHandler.setDispatchResult(dispatchResult);
             } finally {
                 sourceConnector.finishDispatch(dispatchResult);
             }

server/src/main/java/com/mirth/connect/server/controllers/EngineController.java

@@ -22,6 +22,7 @@
 import com.mirth.connect.donkey.model.channel.DebugOptions;
 import com.mirth.connect.donkey.server.channel.DispatchResult;
 import com.mirth.connect.donkey.server.message.batch.BatchMessageException;
+import com.mirth.connect.donkey.server.message.batch.ResponseHandler;
 import com.mirth.connect.model.ChannelStatistics;
 import com.mirth.connect.model.DashboardStatus;
 import com.mirth.connect.model.ServerEventContext;
@@ -73,6 +74,9 @@ public interface EngineController {
 
     public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage, boolean force, boolean canBatch) throws ChannelException, BatchMessageException;
 
+    /** Dispatches a raw message, reporting each message it produced to {@code responseHandler}. */
+    public DispatchResult dispatchRawMessage(String channelId, RawMessage rawMessage, boolean force, boolean canBatch, ResponseHandler responseHandler) throws ChannelException, BatchMessageException;
+
     /**
      * Returns a list of DashboardStatus objects representing the running channels.
      *