Package com.helger.phase4.dump

Class AS4OutgoingDumperFileBased

java.lang.Object

com.helger.phase4.dump.AbstractAS4OutgoingDumperWithHeaders<AS4OutgoingDumperFileBased>

com.helger.phase4.dump.AS4OutgoingDumperFileBased

All Implemented Interfaces:

com.helger.base.trait.IGenericImplTrait<AS4OutgoingDumperFileBased>, IAS4OutgoingDumper

public class AS4OutgoingDumperFileBased
extends AbstractAS4OutgoingDumperWithHeaders<AS4OutgoingDumperFileBased>

File based implementation of IAS4OutgoingDumper.

Since:

0.9.3

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BASE_PATH	The default relative path for outgoing messages.

Fields inherited from class com.helger.phase4.dump.AbstractAS4OutgoingDumperWithHeaders

DEFAULT_INCLUDE_HEADERS

Constructor Summary

Constructors

Constructor	Description
AS4OutgoingDumperFileBased()	Default constructor.
AS4OutgoingDumperFileBased(@NonNull IAS4OutgoingDumperFileProvider aFileProvider)	Constructor with a custom file provider.

Method Summary

Modifier and Type	Method	Description
static @NonNull AS4OutgoingDumperFileBased	createForDirectory(@NonNull File aBaseDirectory)	Create a new instance for the provided directory.
protected final @NonNull IAS4OutgoingDumperFileProvider	getFileProvider()
protected OutputStream	openOutputStream(@NonNull EAS4MessageMode eMsgMode, @Nullable IAS4IncomingMessageMetadata aIncomingMessageMetadata, @Nullable IAS4IncomingMessageState aIncomingState, @NonNull @Nonempty String sMessageID, @Nullable com.helger.http.header.HttpHeaderMap aCustomHeaders, int nTry)	Create the output stream to which the data should be dumped.

Methods inherited from class com.helger.phase4.dump.AbstractAS4OutgoingDumperWithHeaders

isIncludeHeaders, onBeginRequest, onEndRequest, setIncludeHeaders

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.trait.IGenericImplTrait

thisAsT

Field Details

DEFAULT_BASE_PATH

public static final String DEFAULT_BASE_PATH

The default relative path for outgoing messages.

See Also:

• Constant Field Values

Constructor Details

AS4OutgoingDumperFileBased

public AS4OutgoingDumperFileBased()

Default constructor. Writes the files to the AS4 configured data path + DEFAULT_BASE_PATH.

See Also:

• AS4Configuration.getDumpBasePathFile()

AS4OutgoingDumperFileBased

public AS4OutgoingDumperFileBased(@NonNull IAS4OutgoingDumperFileProvider aFileProvider)

Constructor with a custom file provider.

Parameters:

aFileProvider - The file provider that defines where to store the files. May not be null.

Method Details

getFileProvider

protected final @NonNull IAS4OutgoingDumperFileProvider getFileProvider()

openOutputStream

protected OutputStream openOutputStream(@NonNull EAS4MessageMode eMsgMode,
 @Nullable IAS4IncomingMessageMetadata aIncomingMessageMetadata,
 @Nullable IAS4IncomingMessageState aIncomingState,
 @Nonempty
 @NonNull @Nonempty String sMessageID,
 @Nullable com.helger.http.header.HttpHeaderMap aCustomHeaders,
 @Nonnegative
 int nTry)
                                 throws IOException

Description copied from class: AbstractAS4OutgoingDumperWithHeaders

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

Specified by:

openOutputStream in class AbstractAS4OutgoingDumperWithHeaders<AS4OutgoingDumperFileBased>

Parameters:

eMsgMode - Are we dumping a request or a response? Never null. Added in v1.2.0.

aIncomingMessageMetadata - The incoming message metadata. This is always null for requests. This is always non-null for responses. Added in v1.2.0.

aIncomingState - The incoming message processing state. This is always null for requests. This is always non-null for responses. Added in v1.2.0.

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

createForDirectory

public static @NonNull AS4OutgoingDumperFileBased createForDirectory(@NonNull File aBaseDirectory)

Create a new instance for the provided directory.

Parameters:

aBaseDirectory - The absolute directory to be used. May not be null.

Returns:

The created dumper. Never null.

Since:

0.10.2