Package com.helger.phase4.dump

Class AS4IncomingDumperFileBased

java.lang.Object

com.helger.phase4.dump.AbstractAS4IncomingDumperWithHeaders

com.helger.phase4.dump.AS4IncomingDumperFileBased

All Implemented Interfaces:

IAS4IncomingDumper

public class AS4IncomingDumperFileBased
extends AbstractAS4IncomingDumperWithHeaders

Simple file based version of IAS4IncomingDumper. Was moved to this package from com.helger.phase4.servlet.dump in v1.3.0.

Since:

0.9.3

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AS4IncomingDumperFileBased.IFileProvider	Callback interface to create a file based on the provided metadata.

Field Summary

Fields

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

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

DEFAULT_INCLUDE_HEADERS

Constructor Summary

Constructors

Constructor	Description
AS4IncomingDumperFileBased()	Default constructor.
AS4IncomingDumperFileBased(AS4IncomingDumperFileBased.IFileProvider aFileProvider)	Constructor with a custom file provider.

Method Summary

Modifier and Type	Method	Description
static AS4IncomingDumperFileBased	createForDirectory(File aBaseDirectory)	Create a new instance for the provided directory.
protected OutputStream	openOutputStream(IAS4IncomingMessageMetadata aMessageMetadata, com.helger.commons.http.HttpHeaderMap aHttpHeaderMap)	Create the output stream to which the data should be dumped.

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

isIncludeHeaders, onNewRequest, 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.phase4.dump.IAS4IncomingDumper

onEndRequest

Field Details

DEFAULT_BASE_PATH

public static final String DEFAULT_BASE_PATH

The default relative path for incoming messages.

See Also:

• Constant Field Values

Constructor Details

AS4IncomingDumperFileBased

public AS4IncomingDumperFileBased()

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

See Also:

• AS4Configuration.getDumpBasePathFile()

AS4IncomingDumperFileBased

public AS4IncomingDumperFileBased(@Nonnull
 AS4IncomingDumperFileBased.IFileProvider 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

openOutputStream

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

Description copied from class: AbstractAS4IncomingDumperWithHeaders

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

Specified by:

openOutputStream in class AbstractAS4IncomingDumperWithHeaders

Parameters:

aMessageMetadata - Request metadata. Never null. Since v0.9.8.

aHttpHeaderMap - The HTTP headers of the incoming message. Never null.

Returns:

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

Throws:

IOException - On IO error

createForDirectory

@Nonnull
public static AS4IncomingDumperFileBased 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