improve logging, decouple components, allow multiple algorithms

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.0.1</version>
+	<version>2.1.0</version>
 
 	<properties>
 		<java.version>21</java.version>
@@ -13,14 +13,12 @@
 	</properties>
 
 	<dependencies>
-		<!-- https://mvnrepository.com/artifact/jakarta.servlet/jakarta.servlet-api -->
 		<dependency>
 			<groupId>jakarta.servlet</groupId>
 			<artifactId>jakarta.servlet-api</artifactId>
 			<version>6.0.0</version>
 			<scope>provided</scope>
 		</dependency>
-		<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
@@ -37,6 +35,7 @@
 			<artifactId>commons-lang3</artifactId>
 			<version>3.14.0</version>
 		</dependency>
+
 	</dependencies>
 
 </project>

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

@@ -11,10 +11,17 @@
 @Slf4j
 public class ASTMHandlerMarshaller {
 
+  public enum MarshallerMode {
+    ALL,
+    FIRST
+  }
+
   private List<ASTMHandler> handlers;
+  private MarshallerMode mode;
 
-  public ASTMHandlerMarshaller(List<ASTMHandler> handlers) {
+  public ASTMHandlerMarshaller(List<ASTMHandler> handlers, MarshallerMode mode) {
     this.handlers = handlers;
+    this.mode = mode;
   }
 
   public HandleStatus handle(ASTMMessage message) {
@@ -24,7 +31,9 @@ public HandleStatus handle(ASTMMessage message) {
       if (handler.matches(message)) {
         log.debug("handler found for astm message: " + message.hashCode());
         messageHandlers.put(message, handler);
-        break;
+        if (mode == MarshallerMode.FIRST) {
+          break;
+        }
       }
     }
     if (!messageHandlers.containsKey(message)) {

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

@@ -2,9 +2,7 @@
 
 import java.io.IOException;
 import java.net.Socket;
-import java.util.List;
 import lombok.extern.slf4j.Slf4j;
-import org.itech.ahb.lib.common.ASTMInterpreterFactory;
 import org.itech.ahb.lib.common.ASTMMessage;
 import org.itech.ahb.lib.common.HandleStatus;
 import org.itech.ahb.lib.common.exception.ASTMCommunicationException;
@@ -13,57 +11,39 @@
 @Slf4j
 public class ASTMReceiveThread extends Thread {
 
-  private Socket socket;
-  private ASTMInterpreterFactory astmInterpreterFactory;
-  private LIS01A2Communicator communicator;
+  private final Socket socket;
+  private final Communicator communicator;
   private ASTMHandlerMarshaller astmHandlerMarshaller;
 
-  public ASTMReceiveThread(
-    Socket socket,
-    ASTMInterpreterFactory astmInterpreterFactory,
-    ASTMHandlerMarshaller astmHandlerMarshaller
-  ) {
+  public ASTMReceiveThread(Communicator communicator, Socket socket, ASTMHandlerMarshaller astmHandlerMarshaller) {
+    this.communicator = communicator;
     this.socket = socket;
-    this.astmInterpreterFactory = astmInterpreterFactory;
     this.astmHandlerMarshaller = astmHandlerMarshaller;
   }
 
-  public ASTMReceiveThread(LIS01A2Communicator communicator, ASTMHandlerMarshaller astmHandlerMarshaller) {
+  public ASTMReceiveThread(Communicator communicator, ASTMHandlerMarshaller astmHandlerMarshaller) {
     this.communicator = communicator;
+    this.socket = null;
     this.astmHandlerMarshaller = astmHandlerMarshaller;
   }
 
   @Override
   public void run() {
     log.trace("thread started to receive ASTM message");
     try {
-      if (communicator == null) {
-        communicator = new LIS01A2Communicator(astmInterpreterFactory, socket);
-        log.debug("successfully created LIS01A2 communicator " + communicator.getID());
-      }
       try {
-        List<ASTMMessage> messages = communicator.receiveProtocol();
-        for (ASTMMessage message : messages) {
-          HandleStatus status = astmHandlerMarshaller.handle(message);
-          log.debug("astm HandleStatus is: " + status);
-          if (status != HandleStatus.SUCCESS) {
-            log.error("message was not handled successfully");
-          }
+        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");
         }
       } catch (IllegalStateException | FrameParsingException | ASTMCommunicationException e) {
         log.error("an error occurred understanding or handling what was received from the astm sender", e);
       }
     } catch (IOException e) {
       log.error("error occurred communicating with astm sender", e);
     } finally {
-      if (communicator != null) {
-        try {
-          communicator.close();
-          log.debug("successfully closed communicator " + communicator.getID() + " with astm sender");
-        } catch (IOException e) {
-          log.error("error occurred closing communicator " + communicator.getID() + " with astm sender", e);
-        }
-      }
       if (socket != null && !socket.isClosed()) {
         try {
           socket.close();

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

@@ -8,29 +8,44 @@
 @Slf4j
 public class ASTMServlet {
 
+  public enum ASTMVersion {
+    LIS01_A,
+    E1381_95,
+    NON_COMPLIANT
+  }
+
   private final ASTMHandlerMarshaller astmMessageMarshaller;
   private final ASTMInterpreterFactory astmInterpreterFactory;
   private final int listenPort;
+  private final ASTMVersion astmVersion;
 
   public ASTMServlet(
     ASTMHandlerMarshaller astmMessageMarshaller,
     ASTMInterpreterFactory astmInterpreterFactory,
-    int listenPort
+    int listenPort,
+    ASTMVersion astmVersion
   ) {
     this.astmMessageMarshaller = astmMessageMarshaller;
     this.astmInterpreterFactory = astmInterpreterFactory;
     this.listenPort = listenPort;
+    this.astmVersion = astmVersion;
   }
 
   public void listen() {
     try (ServerSocket serverSocket = new ServerSocket(listenPort)) {
-      log.info("Server is listening on port " + listenPort + " for ASTM protocol messages");
+      log.info("Server is listening on port " + listenPort + " for ASTM protocol: " + astmVersion + " messages");
       // Communication Endpoint for the client and server.
       while (true) {
         // Waiting for socket connection
         Socket s = serverSocket.accept();
-        new ASTMReceiveThread(s, astmInterpreterFactory, astmMessageMarshaller).start();
+        new ASTMReceiveThread(
+          new GeneralASTMCommunicator(astmInterpreterFactory, s.getInputStream(), s.getOutputStream(), astmVersion),
+          s,
+          astmMessageMarshaller
+        ).start();
       }
-    } catch (Exception e) {}
+    } catch (Exception e) {
+      log.error("an exception caused the astm server to shut down", e);
+    }
   }
 }

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

@@ -0,0 +1,12 @@
+package org.itech.ahb.lib.astm.servlet;
+
+import java.io.IOException;
+import org.itech.ahb.lib.common.ASTMMessage;
+import org.itech.ahb.lib.common.exception.ASTMCommunicationException;
+import org.itech.ahb.lib.common.exception.FrameParsingException;
+
+public interface Communicator {
+  String getID();
+  boolean sendProtocol(ASTMMessage message) throws ASTMCommunicationException, IOException;
+  ASTMMessage receiveProtocol() throws FrameParsingException, ASTMCommunicationException, IOException;
+}