add loggging and add multiple ASTM ahndler support

Author: CalebSLane

astm-http-lib/pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.itech</groupId>
 	<artifactId>astm-http-lib</artifactId>
-	<version>2.1.0</version>
+	<version>2.2.0</version>
 
 	<properties>
 		<java.version>21</java.version>

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/ASTMHandlerResponse.java

@@ -0,0 +1,25 @@
+package org.itech.ahb.lib.astm;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import org.itech.ahb.lib.astm.servlet.ASTMHandler;
+import org.itech.ahb.lib.common.HandleStatus;
+
+@Data
+@AllArgsConstructor
+@RequiredArgsConstructor
+public class ASTMHandlerResponse {
+
+  @NonNull
+  String response;
+
+  @NonNull
+  HandleStatus status;
+
+  Boolean communicateResponse = false;
+
+  @NonNull
+  ASTMHandler handler;
+}

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMHandler.java

@@ -1,10 +1,12 @@
 package org.itech.ahb.lib.astm.servlet;
 
+import org.itech.ahb.lib.astm.ASTMHandlerResponse;
 import org.itech.ahb.lib.common.ASTMMessage;
-import org.itech.ahb.lib.common.HandleStatus;
 
 public interface ASTMHandler {
-  HandleStatus handle(ASTMMessage message);
+  String getName();
+
+  ASTMHandlerResponse handle(ASTMMessage message);
 
   boolean matches(ASTMMessage message);
 }

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMHandlerMarshaller.java

@@ -1,10 +1,15 @@
 package org.itech.ahb.lib.astm.servlet;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Optional;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.tuple.Pair;
+import org.itech.ahb.lib.astm.ASTMHandlerResponse;
 import org.itech.ahb.lib.common.ASTMMessage;
 import org.itech.ahb.lib.common.HandleStatus;
 
@@ -24,35 +29,49 @@ public ASTMHandlerMarshaller(List<ASTMHandler> handlers, MarshallerMode mode) {
     this.mode = mode;
   }
 
-  public HandleStatus handle(ASTMMessage message) {
-    Map<ASTMMessage, ASTMHandler> messageHandlers = new HashMap<>();
+  public ASTMMarshallerResponse handle(ASTMMessage message) {
+    Map<ASTMMessage, List<ASTMHandler>> messageHandlersMap = new HashMap<>();
     log.debug("finding a handler for astm message: " + message.hashCode());
     for (ASTMHandler handler : handlers) {
       if (handler.matches(message)) {
-        log.debug("handler found for astm message: " + message.hashCode());
-        messageHandlers.put(message, handler);
+        log.debug("handler: '" + handler.getName() + "' found for astm message: " + message.hashCode());
+        List<ASTMHandler> matchingMessageHandlers = messageHandlersMap.getOrDefault(message, new ArrayList<>());
+        matchingMessageHandlers.add(handler);
+        messageHandlersMap.put(message, matchingMessageHandlers);
         if (mode == MarshallerMode.FIRST) {
+          log.debug("marshall mode is FIRST, proceeding with a single handler");
           break;
         }
       }
     }
-    if (!messageHandlers.containsKey(message)) {
+    if (!messageHandlersMap.containsKey(message)) {
       log.warn("astm message received but no handler was configured to handle the message");
+      log.debug("finished handling astm messages");
+      return new ASTMMarshallerResponse();
     }
 
+    List<ASTMHandlerResponse> handleResponses = new ArrayList<>();
     log.debug("handling astm message...");
-    for (Entry<ASTMMessage, ASTMHandler> messageHandler : messageHandlers.entrySet()) {
-      try {
-        HandleStatus status = messageHandler.getValue().handle(messageHandler.getKey());
-        log.debug("finished handling http astm message");
-        return status;
-      } catch (RuntimeException e) {
-        log.error("unexpected error occurred during handling astm message: " + messageHandler.getKey(), e);
-        return HandleStatus.FAIL;
-        // TODO add some handle exception handling. retry queue? db save?
+    for (Entry<ASTMMessage, List<ASTMHandler>> matchingMessageHandlers : messageHandlersMap.entrySet()) {
+      for (ASTMHandler messageHandler : matchingMessageHandlers.getValue()) {
+        try {
+          ASTMHandlerResponse handleResponse = messageHandler.handle(matchingMessageHandlers.getKey());
+          log.debug("'" + messageHandler.getName() + "' finished handling http astm message");
+          handleResponses.add(handleResponse);
+        } catch (RuntimeException e) {
+          log.error(
+            "unexpected error occurred during '" +
+            messageHandler.getName() +
+            "' handling astm message: " +
+            matchingMessageHandlers.getKey(),
+            e
+          );
+          handleResponses.add(new ASTMHandlerResponse("", HandleStatus.FAIL, false, messageHandler));
+          // TODO add some handle exception handling. retry queue? db save?
+          // handler.handleError();
+        }
       }
     }
-    log.debug("finished handling astm messages");
-    return HandleStatus.UNHANDLED;
+    return new ASTMMarshallerResponse(handleResponses);
   }
 }

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMMarshallerResponse.java

@@ -0,0 +1,15 @@
+package org.itech.ahb.lib.astm.servlet;
+
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.itech.ahb.lib.astm.ASTMHandlerResponse;
+
+@Data
+@AllArgsConstructor
+@RequiredArgsConstructor
+public class ASTMMarshallerResponse {
+
+  List<ASTMHandlerResponse> responses;
+}

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMReceiveThread.java

@@ -2,7 +2,11 @@
 
 import java.io.IOException;
 import java.net.Socket;
+import java.util.List;
+import java.util.Optional;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.tuple.Pair;
+import org.itech.ahb.lib.astm.ASTMHandlerResponse;
 import org.itech.ahb.lib.common.ASTMMessage;
 import org.itech.ahb.lib.common.HandleStatus;
 import org.itech.ahb.lib.common.exception.ASTMCommunicationException;
@@ -31,15 +35,25 @@ public ASTMReceiveThread(Communicator communicator, ASTMHandlerMarshaller astmHa
   public void run() {
     log.trace("thread started to receive ASTM message");
     try {
+      ASTMMessage message;
       try {
-        ASTMMessage message = communicator.receiveProtocol();
-        HandleStatus status = astmHandlerMarshaller.handle(message);
-        log.debug("astm HandleStatus is: " + status);
-        if (status != HandleStatus.SUCCESS) {
-          log.error("message was not handled successfully");
-        }
+        message = communicator.receiveProtocol();
       } catch (IllegalStateException | FrameParsingException | ASTMCommunicationException e) {
-        log.error("an error occurred understanding or handling what was received from the astm sender", e);
+        log.error("an error occurred understanding what was received from the astm sender", e);
+        return;
+      }
+      //TODO replace Pairs with more informative types
+      ASTMMarshallerResponse response = astmHandlerMarshaller.handle(message);
+      if (response.getResponses() == null || response.getResponses().size() == 0) {
+        log.error("message was unhandled");
+      } else {
+        for (ASTMHandlerResponse handlerResponse : response.getResponses()) {
+          if (handlerResponse.getStatus() != HandleStatus.SUCCESS) {
+            log.error("message was not handled successfully by: " + handlerResponse.getHandler().getName());
+          } else {
+            log.debug("message was handled successfully by: " + handlerResponse.getHandler().getName());
+          }
+        }
       }
     } catch (IOException e) {
       log.error("error occurred communicating with astm sender", e);

astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/DefaultForwardingASTMToHTTPHandler.java

@@ -8,9 +8,11 @@
 import java.net.http.HttpResponse;
 import java.util.Base64;
 import lombok.extern.slf4j.Slf4j;
+import org.itech.ahb.lib.astm.ASTMHandlerResponse;
 import org.itech.ahb.lib.common.ASTMMessage;
 import org.itech.ahb.lib.common.DefaultASTMMessage;
 import org.itech.ahb.lib.common.HandleStatus;
+import org.itech.ahb.lib.util.LogUtil;
 
 @Slf4j
 public class DefaultForwardingASTMToHTTPHandler implements ASTMHandler {
@@ -32,7 +34,7 @@ public DefaultForwardingASTMToHTTPHandler(URI forwardingUri, String username, ch
   }
 
   @Override
-  public HandleStatus handle(ASTMMessage message) {
+  public ASTMHandlerResponse handle(ASTMMessage message) {
     HttpClient client = HttpClient.newHttpClient();
     log.debug("creating request to forward to http server at " + forwardingUri.toString());
     Builder requestBuilder = HttpRequest.newBuilder() //
@@ -50,17 +52,25 @@ public HandleStatus handle(ASTMMessage message) {
     try {
       log.debug("forwarding request to http server at " + forwardingUri.toString());
       HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
+      log.debug("received " + response.statusCode() + "response from http server at " + forwardingUri.toString());
+      log.trace("response: " + LogUtil.convertForDisplay(response.body()));
       if (response.statusCode() == 200) {
-        return HandleStatus.SUCCESS;
+        return new ASTMHandlerResponse(response.body(), HandleStatus.SUCCESS, false, this);
       }
+      return new ASTMHandlerResponse(response.body(), HandleStatus.FAIL, false, this);
     } catch (IOException | InterruptedException e) {
       log.error("error occurred communicating with http server at " + forwardingUri.toString(), e);
     }
-    return HandleStatus.FAIL;
+    return new ASTMHandlerResponse("", HandleStatus.FAIL, false, this);
   }
 
   @Override
   public boolean matches(ASTMMessage message) {
     return message instanceof DefaultASTMMessage;
   }
+
+  @Override
+  public String getName() {
+    return "Forwarding ASTM to HTTP Handler";
+  }
 }

astm-http-lib/src/main/java/org/itech/ahb/lib/common/HandleStatus.java

@@ -3,5 +3,6 @@
 public enum HandleStatus {
   SUCCESS,
   FAIL,
+  @Deprecated
   UNHANDLED
 }

astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/DefaultForwardingHTTPToASTMHandler.java

@@ -89,7 +89,7 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo
         // the communicator must remain open to receive the line contention. The thread
         // will close the socket
         closeSocket = false;
-        ASTMReceiveThread receiveThread = new ASTMReceiveThread(communicator, astmHandlerMarshaller);
+        ASTMReceiveThread receiveThread = new ASTMReceiveThread(communicator, socket, astmHandlerMarshaller);
         receiveThread.start();
 
         if (message.getMessageLength() == 0) {

astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandlerMarshaller.java

@@ -31,6 +31,7 @@ public HandleStatus handle(ASTMMessage message) {
     return handle(message, Set.of());
   }
 
+  //TODO rework this like ASTMHandler to allow multiple handlers and more informative responses
   public HandleStatus handle(ASTMMessage message, Set<HttpForwardingHandlerInfo> handlersInfos) {
     Map<ASTMMessage, HTTPHandler> messageHandlers = new HashMap<>();
     log.debug("finding a handler for astm http message: " + message.hashCode());