Added RawHttpResponse as field in sending report

Author: phax

phase4-hredelivery-client/src/main/java/com/helger/phase4/hredelivery/Phase4HREdeliverySendingReport.java

@@ -16,6 +16,7 @@
  */
 package com.helger.phase4.hredelivery;
 
+import java.nio.charset.StandardCharsets;
 import java.security.cert.X509Certificate;
 import java.time.OffsetDateTime;
 import java.util.function.BiFunction;
@@ -46,6 +47,7 @@
 import com.helger.peppolid.IParticipantIdentifier;
 import com.helger.peppolid.IProcessIdentifier;
 import com.helger.phase4.CAS4Version;
+import com.helger.phase4.client.AS4ClientSentMessage;
 import com.helger.phase4.ebms3header.Ebms3Error;
 import com.helger.phase4.ebms3header.Ebms3SignalMessage;
 import com.helger.phase4.marshaller.Ebms3SignalMessageMarshaller;
@@ -101,6 +103,7 @@ public class Phase4HREdeliverySendingReport
   private OffsetDateTime m_aAS4SendingDT;
 
   // AS4 response details
+  private AS4ClientSentMessage <byte []> m_aRawHttpResponse;
   private EAS4UserMessageSendResult m_eAS4SendingResult;
   private Exception m_aAS4SendingException;
   private Ebms3SignalMessage m_aAS4ReceivedSignalMsg;
@@ -579,60 +582,37 @@ public void setAS4SendingDT (@Nullable final OffsetDateTime a)
   }
 
   /**
-   * @return The synchronously received AS4 Signal Message from C3. May be <code>null</code>.
-   * @since 4.2.0
+   * @return The raw HTTP response message received from the other side. This is only emitted in
+   *         case of non-success. May be <code>null</code>.
+   * @since 4.2.3
    */
   @Nullable
-  public Ebms3SignalMessage getAS4ReceivedSignalMsg ()
+  public AS4ClientSentMessage <byte []> getRawHttpResponse ()
   {
-    return m_aAS4ReceivedSignalMsg;
+    return m_aRawHttpResponse;
   }
 
   /**
-   * @return The list of AS4 EBMS errors received from C3. May be <code>null</code> or empty.
-   * @since 4.2.0
+   * @return <code>true</code> if a raw response is present, <code>false</code> if not.
+   * @since 4.2.3
    */
-  @Nullable
-  @ReturnsMutableObject
-  public ICommonsList <Ebms3Error> getAS4ReceivedErrors ()
-  {
-    return m_aAS4ResponseErrors;
-  }
-
-  public boolean hasAS4ReceivedSignalMsg ()
+  public boolean hasRawHttpResponse ()
   {
-    return m_aAS4ReceivedSignalMsg != null;
-  }
-
-  public boolean hasAS4ResponseErrors ()
-  {
-    return m_aAS4ResponseErrors != null && m_aAS4ResponseErrors.isNotEmpty ();
+    return m_aRawHttpResponse != null;
   }
 
   /**
-   * Remember the synchronously received AS4 Signal Message from C3.
+   * Set the raw HTTP response message received from the other side. This is only emitted in case of
+   * non-success.
    *
-   * @param a
-   *        The parsed AS4 Signal Message. May be <code>null</code>.
+   * @param aRawHttpResponse
+   *        The raw response to use. May be <code>null</code> to explicit state that it should not
+   *        be part of the sending report.
+   * @since 4.2.3
    */
-  public void setAS4ReceivedSignalMsg (@Nullable final Ebms3SignalMessage a)
+  public void setRawHttpResponse (@Nullable final AS4ClientSentMessage <byte []> aRawHttpResponse)
   {
-    m_aAS4ReceivedSignalMsg = a;
-    if (a != null)
-    {
-      if (a.hasErrorEntries ())
-      {
-        m_aAS4ResponseErrors = new CommonsArrayList <> (a.getError ());
-        m_bAS4ResponseError = true;
-      }
-      else
-        m_bAS4ResponseError = false;
-    }
-    else
-    {
-      m_aAS4ResponseErrors = null;
-      m_bAS4ResponseError = false;
-    }
+    m_aRawHttpResponse = aRawHttpResponse;
   }
 
   /**
@@ -650,6 +630,11 @@ public boolean hasAS4SendingResult ()
     return m_eAS4SendingResult != null;
   }
 
+  public boolean hasUnsuccessfulAS4SendingResult ()
+  {
+    return m_eAS4SendingResult != null && m_eAS4SendingResult.isFailure ();
+  }
+
   /**
    * Remember the overall AS4 sending result.
    *
@@ -687,6 +672,63 @@ public void setAS4SendingException (@Nullable final Exception e)
     m_aAS4SendingException = e;
   }
 
+  /**
+   * @return The synchronously received AS4 Signal Message from C3. May be <code>null</code>.
+   * @since 4.2.0
+   */
+  @Nullable
+  public Ebms3SignalMessage getAS4ReceivedSignalMsg ()
+  {
+    return m_aAS4ReceivedSignalMsg;
+  }
+
+  /**
+   * @return The list of AS4 EBMS errors received from C3. May be <code>null</code> or empty.
+   * @since 4.2.0
+   */
+  @Nullable
+  @ReturnsMutableObject
+  public ICommonsList <Ebms3Error> getAS4ReceivedErrors ()
+  {
+    return m_aAS4ResponseErrors;
+  }
+
+  public boolean hasAS4ReceivedSignalMsg ()
+  {
+    return m_aAS4ReceivedSignalMsg != null;
+  }
+
+  public boolean hasAS4ResponseErrors ()
+  {
+    return m_aAS4ResponseErrors != null && m_aAS4ResponseErrors.isNotEmpty ();
+  }
+
+  /**
+   * Remember the synchronously received AS4 Signal Message from C3.
+   *
+   * @param a
+   *        The parsed AS4 Signal Message. May be <code>null</code>.
+   */
+  public void setAS4ReceivedSignalMsg (@Nullable final Ebms3SignalMessage a)
+  {
+    m_aAS4ReceivedSignalMsg = a;
+    if (a != null)
+    {
+      if (a.hasErrorEntries ())
+      {
+        m_aAS4ResponseErrors = new CommonsArrayList <> (a.getError ());
+        m_bAS4ResponseError = true;
+      }
+      else
+        m_bAS4ResponseError = false;
+    }
+    else
+    {
+      m_aAS4ResponseErrors = null;
+      m_bAS4ResponseError = false;
+    }
+  }
+
   /**
    * @return The overall duration it took to perform the lookup and sending process.
    * @since 4.2.0
@@ -809,6 +851,47 @@ public IJsonObject getAsJsonObject ()
     if (hasAS4SendingDT ())
       aJson.add ("as4SendingDateTime", PDTWebDateHelper.getAsStringXSD (m_aAS4SendingDT));
 
+    // Don't render Raw response in case of success, as the Signal Message is contained anyway
+    if (hasRawHttpResponse () && hasUnsuccessfulAS4SendingResult ())
+    {
+      final IJsonObject aRawHttpResponse = new JsonObject ();
+      if (m_aRawHttpResponse.hasResponseStatusLine ())
+        aRawHttpResponse.add ("statusLine", m_aRawHttpResponse.getResponseStatusLine ().toString ());
+
+      {
+        final IJsonArray aHeaders = new JsonArray ();
+        for (final var aHeader : m_aRawHttpResponse.getResponseHeaders ())
+        {
+          final IJsonObject aJsonHeader = new JsonObject ().add ("name", aHeader.getKey ());
+          switch (aHeader.getValue ().size ())
+          {
+            case 0:
+              break;
+            case 1:
+              aJsonHeader.add ("value", aHeader.getValue ().getFirstOrNull ());
+              break;
+            default:
+              aJsonHeader.add ("value", new JsonArray ().addAll (aHeader.getValue ()));
+              break;
+          }
+          aHeaders.add (aJsonHeader);
+        }
+        aRawHttpResponse.add ("headers", aHeaders);
+      }
+
+      if (m_aRawHttpResponse.hasResponseContent ())
+      {
+        // Does not clone
+        final byte [] aBytes = m_aRawHttpResponse.getResponseContent ();
+        aRawHttpResponse.add ("contentLength", aBytes.length);
+        aRawHttpResponse.add ("content", new String (aBytes, StandardCharsets.UTF_8));
+      }
+      else
+        aRawHttpResponse.add ("contentLength", 0);
+
+      aJson.add ("rawHttpResponse", aRawHttpResponse);
+    }
+
     if (hasAS4SendingResult ())
       aJson.add ("sendingResult", m_eAS4SendingResult.name ());
     if (hasAS4SendingException ())
@@ -940,6 +1023,37 @@ public IMicroElement getAsMicroElement (@Nullable final String sNamespaceURI,
       ret.addElementNS (sNamespaceURI, "AS4SendingDateTime")
          .addText (PDTWebDateHelper.getAsStringXSD (m_aAS4SendingDT));
 
+    // Don't render Raw response in case of success, as the Signal Message is contained anyway
+    if (hasRawHttpResponse () && hasUnsuccessfulAS4SendingResult ())
+    {
+      final IMicroElement aRawHttpResponse = ret.addElementNS (sNamespaceURI, "RawHttpResponse");
+      if (m_aRawHttpResponse.hasResponseStatusLine ())
+        aRawHttpResponse.addElementNS (sNamespaceURI, "StatusLine")
+                        .addText (m_aRawHttpResponse.getResponseStatusLine ().toString ());
+
+      {
+        final IMicroElement aHeaders = aRawHttpResponse.addElementNS (sNamespaceURI, "Headers");
+        for (final var aHeader : m_aRawHttpResponse.getResponseHeaders ())
+        {
+          final IMicroElement aHeaderEl = aHeaders.addElementNS (sNamespaceURI, "Header");
+          aHeaderEl.setAttribute ("name", aHeader.getKey ());
+
+          for (final String sValue : aHeader.getValue ())
+            aHeaderEl.addElementNS (sNamespaceURI, "Value").addText (sValue);
+        }
+      }
+
+      if (m_aRawHttpResponse.hasResponseContent ())
+      {
+        // Does not clone
+        final byte [] aBytes = m_aRawHttpResponse.getResponseContent ();
+        aRawHttpResponse.addElementNS (sNamespaceURI, "ContentLength").addText (aBytes.length);
+        aRawHttpResponse.addElementNS (sNamespaceURI, "Content").addText (new String (aBytes, StandardCharsets.UTF_8));
+      }
+      else
+        aRawHttpResponse.addElementNS (sNamespaceURI, "ContentLength").addText (0);
+    }
+
     if (hasAS4SendingResult ())
       ret.addElementNS (sNamespaceURI, "AS4SendingResult").addText (m_eAS4SendingResult.name ());
     if (hasAS4SendingException ())