Package com.helger.phase4.sender

Enum AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult

java.lang.Object

java.lang.Enum<AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult>

com.helger.phase4.sender.AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.state.ISuccessIndicator, Serializable, Comparable<AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult>, java.lang.constant.Constable

Enclosing class:

AbstractAS4UserMessageBuilder<IMPLTYPE extends AbstractAS4UserMessageBuilder<IMPLTYPE>>

public static enum AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult
extends Enum<AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult>
implements com.helger.commons.id.IHasID<String>, com.helger.commons.state.ISuccessIndicator

Specific enumeration with the result error codes of the AbstractAS4UserMessageBuilder.sendMessageAndCheckForReceipt() method.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AS4_ERROR_MESSAGE_RECEIVED	An AS4 Error Message was received
INVALID_PARAMETERS	Programming error, because not all mandatory fields are filled.
INVALID_SIGNAL_MESSAGE_RECEIVED	An AS4 Signal Message was received, but it was neither a Receipt nor an Error Message but something else.
NO_SIGNAL_MESSAGE_RECEIVED	Some answer was received, but it was no valid AS4 Signal Message
SUCCESS	Everything worked according to plan.
TRANSPORT_ERROR	Something failed on the network or HTTP(S) level

Method Summary

Modifier and Type	Method	Description
static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult	getFromIDOrNull(String sID)
String	getID()
boolean	isRetryFeasible()
boolean	isSuccess()
static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, isFailure, or

Enum Constant Details

INVALID_PARAMETERS

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult INVALID_PARAMETERS

Programming error, because not all mandatory fields are filled.

TRANSPORT_ERROR

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult TRANSPORT_ERROR

Something failed on the network or HTTP(S) level

NO_SIGNAL_MESSAGE_RECEIVED

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult NO_SIGNAL_MESSAGE_RECEIVED

Some answer was received, but it was no valid AS4 Signal Message

AS4_ERROR_MESSAGE_RECEIVED

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult AS4_ERROR_MESSAGE_RECEIVED

An AS4 Error Message was received

INVALID_SIGNAL_MESSAGE_RECEIVED

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult INVALID_SIGNAL_MESSAGE_RECEIVED

An AS4 Signal Message was received, but it was neither a Receipt nor an Error Message but something else.

SUCCESS

public static final AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult SUCCESS

Everything worked according to plan. The message was successfully delivered.

Method Details

values

public static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

Returns:

The ID of the of the error message.

Since:

1.0.0-rc1

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface com.helger.commons.state.ISuccessIndicator

isRetryFeasible

public boolean isRetryFeasible()

Returns:

A recommendation whether a retry might be feasible in case the internal retries were disabled.

Since:

1.0.0-rc1

getFromIDOrNull

@Nullable
public static AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult getFromIDOrNull(@Nullable
 String sID)