add multiple handlers support to HTTP to ASTM

CalebSLane · CalebSLane · commit 01180a988caf · 2024-10-15T14:31:37.000-07:00
diff --git a/astm-http-lib/pom.xml b/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.2.1</version>
+	<version>2.3.0</version>
 
 	<properties>
 		<java.version>21</java.version>
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/ASTMHandlerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/ASTMHandlerResponse.java
@@ -6,11 +6,12 @@
 import lombok.RequiredArgsConstructor;
 import org.itech.ahb.lib.astm.servlet.ASTMHandler;
 import org.itech.ahb.lib.common.HandleStatus;
+import org.itech.ahb.lib.common.HandlerResponse;
 
 @Data
 @AllArgsConstructor
 @RequiredArgsConstructor
-public class ASTMHandlerResponse {
+public class ASTMHandlerResponse implements HandlerResponse {
 
   @NonNull
   String response;
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMForwardingHandlerInfo.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMForwardingHandlerInfo.java
@@ -0,0 +1,4 @@
+package org.itech.ahb.lib.astm.servlet;
+
+//TODO add the capability to add info about forwarding (for example listen on sevaral sockets, and each socket could have a defined forwarding info)
+public class ASTMForwardingHandlerInfo {}
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMHandlerMarshaller.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMHandlerMarshaller.java
@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Set;
 import lombok.extern.slf4j.Slf4j;
 import org.itech.ahb.lib.astm.ASTMHandlerResponse;
 import org.itech.ahb.lib.common.ASTMMessage;
@@ -27,6 +28,10 @@ public ASTMHandlerMarshaller(List<ASTMHandler> handlers, MarshallerMode mode) {
   }
 
   public ASTMMarshallerResponse handle(ASTMMessage message) {
+    return handle(message, Set.of());
+  }
+
+  public ASTMMarshallerResponse handle(ASTMMessage message, Set<ASTMForwardingHandlerInfo> handlersInfos) {
     Map<ASTMMessage, List<ASTMHandler>> messageHandlersMap = new HashMap<>();
     log.debug("finding a handler for astm message: " + message.hashCode());
     for (ASTMHandler handler : handlers) {
@@ -43,7 +48,6 @@ public ASTMMarshallerResponse handle(ASTMMessage 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();
     }
 
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMMarshallerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/astm/servlet/ASTMMarshallerResponse.java
@@ -5,11 +5,12 @@
 import lombok.Data;
 import lombok.RequiredArgsConstructor;
 import org.itech.ahb.lib.astm.ASTMHandlerResponse;
+import org.itech.ahb.lib.common.MarshallerResponse;
 
 @Data
 @AllArgsConstructor
 @RequiredArgsConstructor
-public class ASTMMarshallerResponse {
+public class ASTMMarshallerResponse implements MarshallerResponse {
 
   List<ASTMHandlerResponse> responses;
 }
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/common/HandlerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/common/HandlerResponse.java
@@ -0,0 +1,7 @@
+package org.itech.ahb.lib.common;
+
+public interface HandlerResponse {
+  HandleStatus getStatus();
+  Boolean getCommunicateResponse();
+  String getResponse();
+}
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/common/MarshallerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/common/MarshallerResponse.java
@@ -0,0 +1,3 @@
+package org.itech.ahb.lib.common;
+
+public interface MarshallerResponse {}
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/DefaultForwardingHTTPToASTMHandler.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/DefaultForwardingHTTPToASTMHandler.java
@@ -40,7 +40,8 @@ public DefaultForwardingHTTPToASTMHandler(
   }
 
   @Override
-  public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfos) throws FrameParsingException {
+  public HTTPHandlerResponse handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfos)
+    throws FrameParsingException {
     Socket socket = null;
     boolean success = false;
     boolean closeSocket = true;
@@ -49,8 +50,8 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo
     int forwardingPort = this.defaultForwardingPort;
     ASTMVersion forwardingProtocol = this.defaultForwardingProtocol;
     for (HTTPHandlerInfo handlerInfo : handlerInfos) {
-      if (handlerInfo instanceof HttpForwardingHandlerInfo) {
-        HttpForwardingHandlerInfo httpForwardingHandlerInfo = (HttpForwardingHandlerInfo) handlerInfo;
+      if (handlerInfo instanceof HTTPForwardingHandlerInfo) {
+        HTTPForwardingHandlerInfo httpForwardingHandlerInfo = (HTTPForwardingHandlerInfo) handlerInfo;
         forwardingAddress = StringUtils.isBlank(httpForwardingHandlerInfo.getForwardAddress())
           ? forwardingAddress
           : httpForwardingHandlerInfo.getForwardAddress();
@@ -99,7 +100,7 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo
       }
     } catch (IOException | ASTMCommunicationException e) {
       log.error("error occurred communicating with astm server at " + forwardingAddress + ":" + forwardingPort, e);
-      return HandleStatus.FAIL;
+      return new HTTPHandlerResponse("", HandleStatus.FAIL, false, this);
     } finally {
       if (closeSocket) {
         if (socket != null && !socket.isClosed()) {
@@ -115,11 +116,16 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo
         }
       }
     }
-    return success ? HandleStatus.SUCCESS : HandleStatus.FAIL;
+    return new HTTPHandlerResponse("", success ? HandleStatus.SUCCESS : HandleStatus.FAIL, false, this);
   }
 
   @Override
   public boolean matches(ASTMMessage message) {
     return message instanceof DefaultASTMMessage;
   }
+
+  @Override
+  public String getName() {
+    return "Default HTTP to ASTM Handler";
+  }
 }
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPForwardingHandlerInfo.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPForwardingHandlerInfo.java
@@ -4,7 +4,7 @@
 import org.itech.ahb.lib.astm.servlet.ASTMServlet.ASTMVersion;
 
 @Data
-public class HttpForwardingHandlerInfo implements HTTPHandlerInfo {
+public class HTTPForwardingHandlerInfo implements HTTPHandlerInfo {
 
   private String forwardAddress;
   private int forwardPort;
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandler.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandler.java
@@ -2,11 +2,12 @@
 
 import java.util.Set;
 import org.itech.ahb.lib.common.ASTMMessage;
-import org.itech.ahb.lib.common.HandleStatus;
 import org.itech.ahb.lib.common.exception.FrameParsingException;
 
 public interface HTTPHandler {
   boolean matches(ASTMMessage message);
 
-  HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo) throws FrameParsingException;
+  HTTPHandlerResponse handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo) throws FrameParsingException;
+
+  String getName();
 }
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandlerMarshaller.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandlerMarshaller.java
@@ -1,5 +1,6 @@
 package org.itech.ahb.lib.http.servlet;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -27,47 +28,58 @@ public HTTPHandlerMarshaller(List<HTTPHandler> handlers, MarshallerMode mode) {
     this.mode = mode;
   }
 
-  public HandleStatus handle(ASTMMessage message) {
+  public HTTPMarshallerResponse 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<>();
+  public HTTPMarshallerResponse handle(ASTMMessage message, Set<HTTPForwardingHandlerInfo> handlersInfos) {
+    Map<ASTMMessage, List<HTTPHandler>> messageHandlersMap = new HashMap<>();
     log.debug("finding a handler for astm http message: " + message.hashCode());
     for (HTTPHandler handler : handlers) {
       if (handler.matches(message)) {
         log.debug("handler found for astm http message: " + message.hashCode());
-        messageHandlers.put(message, handler);
+        List<HTTPHandler> 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 http message received but no handler was configured to handle the message");
+      return new HTTPMarshallerResponse();
     }
 
+    List<HTTPHandlerResponse> handleResponses = new ArrayList<>();
     log.debug("handling astm http message...");
-    for (Entry<ASTMMessage, HTTPHandler> messageHandler : messageHandlers.entrySet()) {
-      try {
-        HandleStatus status = messageHandler
-          .getValue()
-          .handle(
-            messageHandler.getKey(),
-            handlersInfos.stream().filter(e -> e.supports(messageHandler.getValue())).collect(Collectors.toSet())
+    for (Entry<ASTMMessage, List<HTTPHandler>> matchingMessageHandlers : messageHandlersMap.entrySet()) {
+      for (HTTPHandler messageHandler : matchingMessageHandlers.getValue()) {
+        try {
+          HTTPHandlerResponse handleResponse = messageHandler.handle(
+            matchingMessageHandlers.getKey(),
+            handlersInfos.stream().filter(e -> e.supports(messageHandler)).collect(Collectors.toSet())
+          );
+          log.debug("'" + messageHandler.getName() + "' finished handling astm http message");
+          handleResponses.add(handleResponse);
+        } catch (FrameParsingException e) {
+          log.error("couldn't parse frames into a message", e);
+          handleResponses.add(new HTTPHandlerResponse("", HandleStatus.FAIL, false, messageHandler));
+        } catch (RuntimeException e) {
+          log.error(
+            "unexpected error occurred during '" +
+            messageHandler.getName() +
+            "' handling astm http message: " +
+            matchingMessageHandlers.getKey(),
+            e
           );
-        log.debug("finished attempting handling astm http message");
-        return status;
-      } catch (RuntimeException e) {
-        log.error("unexpected error occurred during handling astm http message: " + messageHandler.getKey(), e);
-        return HandleStatus.FAIL;
-        // TODO add some handle exception handling. retry queue? db save?
-      } catch (FrameParsingException e) {
-        log.error("Line contention has occured and could not parse the received information", e);
-        return HandleStatus.FAIL;
+          handleResponses.add(new HTTPHandlerResponse("", HandleStatus.FAIL, false, messageHandler));
+          // TODO add some handle exception handling. retry queue? db save?
+        }
       }
     }
-    return HandleStatus.UNHANDLED;
+    return new HTTPMarshallerResponse(handleResponses);
   }
 }
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandlerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPHandlerResponse.java
@@ -0,0 +1,25 @@
+package org.itech.ahb.lib.http.servlet;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import org.itech.ahb.lib.common.HandleStatus;
+import org.itech.ahb.lib.common.HandlerResponse;
+
+@Data
+@AllArgsConstructor
+@RequiredArgsConstructor
+public class HTTPHandlerResponse implements HandlerResponse {
+
+  @NonNull
+  String response;
+
+  @NonNull
+  HandleStatus status;
+
+  Boolean communicateResponse = false;
+
+  @NonNull
+  HTTPHandler handler;
+}
diff --git a/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPMarshallerResponse.java b/astm-http-lib/src/main/java/org/itech/ahb/lib/http/servlet/HTTPMarshallerResponse.java
@@ -0,0 +1,15 @@
+package org.itech.ahb.lib.http.servlet;
+
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.itech.ahb.lib.common.MarshallerResponse;
+
+@Data
+@AllArgsConstructor
+@RequiredArgsConstructor
+public class HTTPMarshallerResponse implements MarshallerResponse {
+
+  List<HTTPHandlerResponse> responses;
+}
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
 	</parent>
 	<groupId>org.itech</groupId>
 	<artifactId>astm-http-bridge</artifactId>
-	<version>2.2.1</version>
+	<version>2.3.0</version>
 	<name>astm-http-bridge</name>
 	<description>Translates astm to http and vice versa</description>
 	<properties>
@@ -30,7 +30,7 @@
 		<dependency>
 			<groupId>org.itech</groupId>
 			<artifactId>astm-http-lib</artifactId>
-			<version>2.2.1</version>
+			<version>2.3.0</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
@@ -57,4 +57,4 @@
 		</plugins>
 	</build>
 
-</project>
+</project>
diff --git a/src/main/java/org/itech/ahb/controller/HTTPListenController.java b/src/main/java/org/itech/ahb/controller/HTTPListenController.java
@@ -12,11 +12,13 @@
 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.http.HTTPHandlerResponse;
 import org.itech.ahb.lib.http.servlet.DefaultForwardingHTTPToASTMHandler;
+import org.itech.ahb.lib.http.servlet.HTTPForwardingHandlerInfo;
 import org.itech.ahb.lib.http.servlet.HTTPHandler;
 import org.itech.ahb.lib.http.servlet.HTTPHandlerMarshaller;
 import org.itech.ahb.lib.http.servlet.HTTPHandlerMarshaller.MarshallerMode;
-import org.itech.ahb.lib.http.servlet.HttpForwardingHandlerInfo;
+import org.itech.ahb.lib.http.servlet.HTTPHandlerResponse;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -49,7 +51,7 @@ public HTTPListenController(
   }
 
   @PostMapping
-  public void recieveASTMMessageOverHttp(
+  public HTTPMarshallerResponse recieveASTMMessageOverHttp(
     @RequestBody(required = false) String requestBody,
     @RequestParam(required = false) String forwardAddress,
     @RequestParam(required = false, defaultValue = "0") Integer forwardPort,
@@ -60,16 +62,22 @@ public void recieveASTMMessageOverHttp(
     ASTMMessage message = interpreterFactory
       .createInterpreterForText(requestBody)
       .interpretASTMTextToMessage(requestBody);
-    HttpForwardingHandlerInfo handlerInfo = new HttpForwardingHandlerInfo();
+    HTTPForwardingHandlerInfo handlerInfo = new HTTPForwardingHandlerInfo();
     handlerInfo.setForwardAddress(forwardAddress);
     handlerInfo.setForwardPort(forwardPort);
     handlerInfo.setForwardAstmVersion(forwardAstmVersion);
-    HandleStatus status = httpHandlerMarshaller.handle(message, Set.of(handlerInfo));
-    log.debug("http HandleStatus is: " + status);
-    if (status.equals(HandleStatus.SUCCESS)) {
-      response.setStatus(HttpServletResponse.SC_OK);
+    HTTPMarshallerResponse response = httpHandlerMarshaller.handle(message, Set.of(handlerInfo));
+    if (response.getResponses() == null || response.getResponses().size() == 0) {
+      log.error("message was unhandled");
     } else {
-      response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
+      for (HTTPHandlerResponse 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());
+        }
+      }
     }
+    return response;
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package org.itech.ahb.lib.common;`
	`2`	`+`
	`3`	`+public interface MarshallerResponse {}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,8 @@ public DefaultForwardingHTTPToASTMHandler(`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`@Override`
`43`		`- public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfos) throws FrameParsingException {`
	`43`	`+ public HTTPHandlerResponse handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfos)`
	`44`	`+ throws FrameParsingException {`
`44`	`45`	`Socket socket = null;`
`45`	`46`	`boolean success = false;`
`46`	`47`	`boolean closeSocket = true;`
`@@ -49,8 +50,8 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo`
`49`	`50`	`int forwardingPort = this.defaultForwardingPort;`
`50`	`51`	`ASTMVersion forwardingProtocol = this.defaultForwardingProtocol;`
`51`	`52`	`for (HTTPHandlerInfo handlerInfo : handlerInfos) {`
`52`		`- if (handlerInfo instanceof HttpForwardingHandlerInfo) {`
`53`		`- HttpForwardingHandlerInfo httpForwardingHandlerInfo = (HttpForwardingHandlerInfo) handlerInfo;`
	`53`	`+ if (handlerInfo instanceof HTTPForwardingHandlerInfo) {`
	`54`	`+ HTTPForwardingHandlerInfo httpForwardingHandlerInfo = (HTTPForwardingHandlerInfo) handlerInfo;`
`54`	`55`	`forwardingAddress = StringUtils.isBlank(httpForwardingHandlerInfo.getForwardAddress())`
`55`	`56`	`? forwardingAddress`
`56`	`57`	`: httpForwardingHandlerInfo.getForwardAddress();`
`@@ -99,7 +100,7 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo`
`99`	`100`	`}`
`100`	`101`	`} catch (IOException \| ASTMCommunicationException e) {`
`101`	`102`	`log.error("error occurred communicating with astm server at " + forwardingAddress + ":" + forwardingPort, e);`
`102`		`- return HandleStatus.FAIL;`
	`103`	`+ return new HTTPHandlerResponse("", HandleStatus.FAIL, false, this);`
`103`	`104`	`} finally {`
`104`	`105`	`if (closeSocket) {`
`105`	`106`	`if (socket != null && !socket.isClosed()) {`
`@@ -115,11 +116,16 @@ public HandleStatus handle(ASTMMessage message, Set<HTTPHandlerInfo> handlerInfo`
`115`	`116`	`}`
`116`	`117`	`}`
`117`	`118`	`}`
`118`		`- return success ? HandleStatus.SUCCESS : HandleStatus.FAIL;`
	`119`	`+ return new HTTPHandlerResponse("", success ? HandleStatus.SUCCESS : HandleStatus.FAIL, false, this);`
`119`	`120`	`}`
`120`	`121`
`121`	`122`	`@Override`
`122`	`123`	`public boolean matches(ASTMMessage message) {`
`123`	`124`	`return message instanceof DefaultASTMMessage;`
`124`	`125`	`}`
	`126`	`+`
	`127`	`+ @Override`
	`128`	`+ public String getName() {`
	`129`	`+ return "Default HTTP to ASTM Handler";`
	`130`	`+ }`
`125`	`131`	`}`