com.helger.phase4.dump

Interface IAS4OutgoingDumper

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAS4OutgoingDumperWithHeaders, AS4OutgoingDumperSingleUse

public interface IAS4OutgoingDumper
extends Serializable

Interface for dumping outgoing requests

Since:

0.9.0

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
OutputStream	onBeginRequest(String sMessageID, com.helger.commons.http.HttpHeaderMap aCustomHeaders, int nTry) Called for new requests.
default void	onEndRequest(String sMessageID) Called after the request is finished.

Method Detail

onBeginRequest

@Nullable
OutputStream onBeginRequest(@Nonnull @Nonempty
                                       String sMessageID,
                                       @Nullable
                                       com.helger.commons.http.HttpHeaderMap aCustomHeaders,
                                       @Nonnegative
                                       int nTry)
                                throws IOException

Called for new requests.

Parameters:

sMessageID - The message ID of the outgoing message. Neither null nor empty.

aCustomHeaders - Custom headers to be added to the HTTP entity. May be null.

nTry - The index of the try. The first try has always index 0, the first retry has index 1, the second retry has index 2 etc. Always ≥ 0.

Returns:

If null is returned, nothing is dumped, else each byte written to the target stream is also written to that output stream.

Throws:

IOException - in case of an error

onEndRequest

default void onEndRequest(@Nonnull @Nonempty
                          String sMessageID)

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:

sMessageID - The message ID for which something happens