com.helger.phase4.dump

Interface IAS4IncomingDumper

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAS4IncomingDumperWithHeaders, AS4IncomingDumperSingleUse

public interface IAS4IncomingDumper
extends Serializable

Interface for dumping incoming requests

Since:

0.9.0

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default void	onEndRequest(IAS4IncomingMessageMetadata aMessageMetadata) Called after the request is finished.
OutputStream	onNewRequest(IAS4IncomingMessageMetadata aMessageMetadata, com.helger.commons.http.HttpHeaderMap aHttpHeaderMap) Called for new requests.

Method Detail

onNewRequest

@Nullable
OutputStream onNewRequest(@Nonnull
                                     IAS4IncomingMessageMetadata aMessageMetadata,
                                     @Nonnull
                                     com.helger.commons.http.HttpHeaderMap aHttpHeaderMap)
                              throws IOException

Called for new requests.

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.

Parameters:

aMessageMetadata - Message metadata. Never null.

Since:

v0.9.9