Package com.helger.phase4.dump

Interface IAS4OutgoingDumperFileProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IAS4OutgoingDumperFileProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_FILE_EXTENSION	The default file extension to be used

Method Summary

Modifier and Type	Method	Description
static @NonNull String	getDefaultDirectoryAndFilename(@NonNull @Nonempty String sAS4MessageID, int nTry)
static @NonNull String	getDefaultDirectoryName(@NonNull OffsetDateTime aNow)
static @NonNull String	getDefaultFilename(@NonNull OffsetDateTime aNow, @NonNull @Nonempty String sAS4MessageID, int nTry)
@NonNull File	getFile(@NonNull EAS4MessageMode eMsgMode, @NonNull @Nonempty String sAS4MessageID, int nTry)	Get the File to write the dump to.

Field Details

DEFAULT_FILE_EXTENSION

static final String DEFAULT_FILE_EXTENSION

The default file extension to be used

See Also:

• Constant Field Values

Method Details

getFile

@NonNull File getFile(@NonNull EAS4MessageMode eMsgMode,
 @Nonempty
 @NonNull @Nonempty String sAS4MessageID,
 @Nonnegative
 int nTry)

Get the File to write the dump to. The filename must be globally unique. The resulting file should be an absolute path.

Parameters:

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

sAS4MessageID - The AS4 message ID that was send out. Neither null nor empty.

nTry - The number of the try to send the message. The initial try has value 0, the first retry has value 1 etc.

Returns:

A non-null File.

See Also:

• AS4Configuration.getDumpBasePath()

getDefaultDirectoryName

static @NonNull String getDefaultDirectoryName(@NonNull OffsetDateTime aNow)

getDefaultFilename

static @NonNull String getDefaultFilename(@NonNull OffsetDateTime aNow,
 @Nonempty
 @NonNull @Nonempty String sAS4MessageID,
 @Nonnegative
 int nTry)

getDefaultDirectoryAndFilename

static @NonNull String getDefaultDirectoryAndFilename(@Nonempty
 @NonNull @Nonempty String sAS4MessageID,
 @Nonnegative
 int nTry)