com.helger.phase4.dump

Class AbstractAS4OutgoingDumperWithHeaders

java.lang.Object

com.helger.phase4.dump.AbstractAS4OutgoingDumperWithHeaders

All Implemented Interfaces:

IAS4OutgoingDumper, Serializable

Direct Known Subclasses:

AS4OutgoingDumperSingleUse

public abstract class AbstractAS4OutgoingDumperWithHeaders
extends Object
implements IAS4OutgoingDumper

Abstract implementation of IAS4OutgoingDumper that always adds the custom headers

Since:

0.9.7

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAS4OutgoingDumperWithHeaders()

Method Summary

Modifier and Type	Method and Description
OutputStream	onBeginRequest(String sMessageID, com.helger.commons.http.HttpHeaderMap aCustomHeaders, int nTry) Called for new requests.
protected abstract OutputStream	openOutputStream(String sMessageID, com.helger.commons.http.HttpHeaderMap aCustomHeaders, int nTry) Create the output stream to which the data should be dumped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.helger.phase4.dump.IAS4OutgoingDumper

onEndRequest

Constructor Detail

AbstractAS4OutgoingDumperWithHeaders

public AbstractAS4OutgoingDumperWithHeaders()

Method Detail

openOutputStream

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

Create the output stream to which the data should be dumped.

Parameters:

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

aCustomHeaders - The HTTP headers of the outgoing message. Never 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:

The output stream to dump to or null if no dumping should be performed.

Throws:

IOException - On IO error

onBeginRequest

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

Description copied from interface: IAS4OutgoingDumper

Called for new requests.

Specified by:

onBeginRequest in interface IAS4OutgoingDumper

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