Improved comments

phax · Jul 31, 2024 · 2366079 · 2366079
1 parent 8e934fd
commit 2366079
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/...src/main/java/com/helger/phase4/peppol/server/spi/StoringPeppolIncomingSBDHandlerSPI.java b/...src/main/java/com/helger/phase4/peppol/server/spi/StoringPeppolIncomingSBDHandlerSPI.java
@@ -70,6 +70,7 @@ public void handleIncomingSBD (@Nonnull final IAS4IncomingMessageMetadata aMessa
                                        " bytes)");
     LOGGER.info ("Successfully wrote SBD to '" + aFile.getAbsolutePath () + "'");
 
+    // Check if any "MessageProperty" with name "MockAction" is contained
     final Ebms3Property aMockAction = CollectionHelper.findFirst (aUserMessage.getMessageProperties ().getProperty (),
                                                                   x -> "MockAction".equals (x.getName ()));
     if (aMockAction != null)

diff --git a/...rc/main/java/com/helger/phase4/peppol/servlet/Phase4PeppolServletMessageProcessorSPI.java b/...rc/main/java/com/helger/phase4/peppol/servlet/Phase4PeppolServletMessageProcessorSPI.java
@@ -98,13 +98,19 @@
  * main goal of this class is to implement the Peppol specific requirements of
  * packaging data in SBDH. Users of this package must implement
  * {@link IPhase4PeppolIncomingSBDHandlerSPI} instead which provides a more
- * Peppol-style SPI handler.
+ * Peppol-style SPI handler. This class is instantiated only once, therefore
+ * changing the state of this class may have unintended side effects.
  *
  * @author Philip Helger
  */
 @IsSPIImplementation
 public class Phase4PeppolServletMessageProcessorSPI implements IAS4ServletMessageProcessorSPI
 {
+  /**
+   * This class represents the data of a single AS4 attachment.
+   *
+   * @author Philip Helger
+   */
   private static final class ReadAttachment
   {
     private String m_sID;
@@ -592,7 +598,7 @@ public AS4MessageProcessorResult processAS4UserMessage (@Nonnull final IAS4Incom
       LOGGER.debug (sLogPrefix + "  AS4 Action = '" + sAction + "'");
       LOGGER.debug (sLogPrefix + "  AS4 ConversationId = '" + sConversationID + "'");
 
-      // Log source properties
+      // Log User Message Message Properties
       if (aUserMessage.getMessageProperties () != null && aUserMessage.getMessageProperties ().hasPropertyEntries ())
       {
         LOGGER.debug (sLogPrefix + "  AS4 MessageProperties:");