Package com.helger.phase4.dump

Class AS4RawResponseConsumerWriteToFile

java.lang.Object

com.helger.phase4.sender.AbstractAS4RawResponseConsumer<AS4RawResponseConsumerWriteToFile>

com.helger.phase4.dump.AS4RawResponseConsumerWriteToFile

All Implemented Interfaces:

com.helger.base.trait.IGenericImplTrait<AS4RawResponseConsumerWriteToFile>, IAS4RawResponseConsumer

public class AS4RawResponseConsumerWriteToFile
extends AbstractAS4RawResponseConsumer<AS4RawResponseConsumerWriteToFile>

Example implementation of IAS4RawResponseConsumer writing to a file.

Author:

Philip Helger

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.helger.phase4.sender.AbstractAS4RawResponseConsumer

DEFAULT_HANDLE_HTTP_HEADERS, DEFAULT_HANDLE_STATUS_LINE

Constructor Summary

Constructors

Constructor	Description
AS4RawResponseConsumerWriteToFile()	Default constructor.
AS4RawResponseConsumerWriteToFile(@NonNull AS4RawResponseConsumerWriteToFile.IFileProvider aFileProvider)	Constructor with a custom file provider.

Method Summary

Modifier and Type	Method	Description
static @NonNull AS4RawResponseConsumerWriteToFile	createForDirectory(@NonNull File aBaseDirectory)	Create a new instance for the provided directory.
final @Nullable Consumer<? super File>	getFileOpenCallback()
void	handleResponse(@NonNull AS4ClientSentMessage<byte[]> aResponseEntity)	Handling a HTTP response
final @NonNull AS4RawResponseConsumerWriteToFile	setFileOpenCallback(@NonNull Consumer<? super File> aFileOpenCallback)	Set the callback to be invoked every time a File is opened for writing.

Methods inherited from class com.helger.phase4.sender.AbstractAS4RawResponseConsumer

isHandleHttpHeaders, isHandleStatusLine, setHandleHttpHeaders, setHandleStatusLine, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.phase4.sender.IAS4RawResponseConsumer

and

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

thisAsT

Constructor Details

AS4RawResponseConsumerWriteToFile

public AS4RawResponseConsumerWriteToFile()

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

See Also:

• AS4Configuration.getDumpBasePathFile()

AS4RawResponseConsumerWriteToFile

public AS4RawResponseConsumerWriteToFile(@NonNull AS4RawResponseConsumerWriteToFile.IFileProvider aFileProvider)

Constructor with a custom file provider.

Parameters:

aFileProvider - The file provider to be used. May not be null.

Since:

0.10.2

Method Details

getFileOpenCallback

public final @Nullable Consumer<? super File> getFileOpenCallback()

Returns:

The optional callback that is invoked for every file that is opened. This may be used to grab the effective filename. May be null.

Since:

1.4.1

setFileOpenCallback

public final @NonNull AS4RawResponseConsumerWriteToFile setFileOpenCallback(@NonNull Consumer<? super File> aFileOpenCallback)

Set the callback to be invoked every time a File is opened for writing.

Parameters:

aFileOpenCallback - The callback to be used. May be null.

Returns:

this for chaining

Since:

1.4.1

handleResponse

public void handleResponse(@NonNull AS4ClientSentMessage<byte[]> aResponseEntity)
                    throws Phase4Exception

Description copied from interface: IAS4RawResponseConsumer

Handling a HTTP response

Parameters:

aResponseEntity - The response message in relation to the source message

Throws:

Phase4Exception - In case of error.

createForDirectory

public static @NonNull AS4RawResponseConsumerWriteToFile 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 instance. Never null.

Since:

0.10.2