Package com.helger.phase4.sender

Enum EAS4UserMessageSendResult

java.lang.Object
java.lang.Enum<EAS4UserMessageSendResult>
com.helger.phase4.sender.EAS4UserMessageSendResult
All Implemented Interfaces:
com.helger.commons.id.IHasID<String>, com.helger.commons.state.ISuccessIndicator, Serializable, Comparable<EAS4UserMessageSendResult>, java.lang.constant.Constable
public enum EAS4UserMessageSendResult extends Enum<EAS4UserMessageSendResult> implements com.helger.commons.id.IHasID<String>, com.helger.commons.state.ISuccessIndicator
Specific enumeration with the result error codes of the AbstractAS4UserMessageBuilder.sendMessageAndCheckForReceipt() method.
Old name before v3: ESimpleUserMessageSendResult
Author:
Philip Helger

  • Enum Constant Details

    • INVALID_PARAMETERS

      public static final EAS4UserMessageSendResult INVALID_PARAMETERS
      Programming error, because not all mandatory fields are filled.

    • TRANSPORT_ERROR

      public static final EAS4UserMessageSendResult TRANSPORT_ERROR
      Something failed on the network or HTTP(S) level

    • NO_SIGNAL_MESSAGE_RECEIVED

      public static final EAS4UserMessageSendResult NO_SIGNAL_MESSAGE_RECEIVED
      Some answer was received, but it was no valid AS4 Signal Message

    • AS4_ERROR_MESSAGE_RECEIVED

      public static final EAS4UserMessageSendResult AS4_ERROR_MESSAGE_RECEIVED
      An AS4 Error Message was received

    • INVALID_SIGNAL_MESSAGE_RECEIVED

      public static final EAS4UserMessageSendResult 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 EAS4UserMessageSendResult SUCCESS
      Everything worked according to plan. The message was successfully delivered.

  • Method Details

    • values

      public static EAS4UserMessageSendResult[] 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 EAS4UserMessageSendResult 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 EAS4UserMessageSendResult getFromIDOrNull(@Nullable String sID)