Package com.helger.phase4.dump

Interface IAS4IncomingDumper

All Known Implementing Classes:
AbstractAS4IncomingDumperWithHeaders, AS4IncomingDumperFileBased, AS4IncomingDumperFileBased, AS4IncomingDumperSingleUse
public interface IAS4IncomingDumper
Interface for dumping incoming requests
Since:
0.9.0
Author:
Philip Helger

  • Method Details

    • onNewRequest

      @Nullable OutputStream onNewRequest(@Nonnull IAS4IncomingMessageMetadata aMessageMetadata, @Nonnull com.helger.commons.http.HttpHeaderMap aHttpHeaderMap) throws IOException
      Called for new requests. It's the responsibility of the caller to close the created output stream.
      Parameters:
      aMessageMetadata - Message metadata. Never null. Since v0.9.8.
      aHttpHeaderMap - The HTTP headers of the request. Never null.
      Returns:
      If null is returned, nothing is dumped, else each byte read from the source stream is written to that output stream.
      Throws:
      IOException - in case of an error
      Since:
      v0.9.6 the parameter changed from HttpServletRequest to HttpHeaderMap

    • onEndRequest

      default void onEndRequest(@Nonnull IAS4IncomingMessageMetadata aMessageMetadata)
      Called after the request is finished. Can e.g. be used to cleanup resources belonging to the message. This method may not throw an exception. Since 1.3.0 this method is only called, if onNewRequest(IAS4IncomingMessageMetadata, HttpHeaderMap) returned non-null.
      Parameters:
      aMessageMetadata - Message metadata. Never null.
      Since:
      v0.9.9