com.helger.phase4.error

Enum EEbmsError

java.lang.Object

java.lang.Enum<EEbmsError>

com.helger.phase4.error.EEbmsError

All Implemented Interfaces:

IEbmsError, Serializable, Comparable<EEbmsError>

public enum EEbmsError
extends Enum<EEbmsError>
implements IEbmsError

Enumeration with all predefined EBMS errors based on the specs. Use IEbmsError for a generic interface.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
EBMS_CONNECTION_FAILURE
EBMS_DECOMPRESSION_FAILURE
EBMS_DELIVERY_FAILURE
EBMS_DYSFUNCTIONAL_RELIABILITY
EBMS_EMPTY_MESSAGE_PARTITION_CHANNEL
EBMS_EXTERNAL_PAYLOAD_ERROR
EBMS_FAILED_AUTHENTICATION
EBMS_FAILED_DECRYPTION
EBMS_FEATURE_NOT_SUPPORTED
EBMS_FEATURE_NOT_SUPPORTED_INCONSISTENT
EBMS_INVALID_HEADER
EBMS_INVALID_RECEIPT
EBMS_MIME_INCONSISTENCY
EBMS_MISSING_RECEIPT
EBMS_OTHER
EBMS_POLICY_NONCOMPLIANCE
EBMS_PROCESSING_MODE_MISMATCH
EBMS_VALUE_INCONSISTENT
EBMS_VALUE_NOT_RECOGNIZED

Method Summary

Modifier and Type	Method and Description
EEbmsErrorCategory	getCategory() Gets the value of the category property.
String	getErrorCode() Gets the value of the errorCode property.
com.helger.commons.text.display.IHasDisplayText	getErrorDetail() Gets the value of the errorDetail property.
static EEbmsError	getFromErrorCodeOrNull(String sErrorCode)
static EEbmsError	getFromIErrorOrNull(com.helger.commons.error.IError aError)
EEbmsErrorSeverity	getSeverity() Gets the value of the severity property.
String	getShortDescription() Gets the value of the shortDescription property.
static EEbmsError	valueOf(String name) Returns the enum constant of this type with the specified name.
static EEbmsError[]	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, 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.phase4.error.IEbmsError

getAsEbms3Error, getAsEbms3Error, getAsEbms3Error, getAsEbms3Error, getAsError

Enum Constant Detail

EBMS_VALUE_NOT_RECOGNIZED

public static final EEbmsError EBMS_VALUE_NOT_RECOGNIZED

EBMS_FEATURE_NOT_SUPPORTED

public static final EEbmsError EBMS_FEATURE_NOT_SUPPORTED

EBMS_VALUE_INCONSISTENT

public static final EEbmsError EBMS_VALUE_INCONSISTENT

EBMS_OTHER

public static final EEbmsError EBMS_OTHER

EBMS_CONNECTION_FAILURE

public static final EEbmsError EBMS_CONNECTION_FAILURE

EBMS_EMPTY_MESSAGE_PARTITION_CHANNEL

public static final EEbmsError EBMS_EMPTY_MESSAGE_PARTITION_CHANNEL

EBMS_MIME_INCONSISTENCY

public static final EEbmsError EBMS_MIME_INCONSISTENCY

EBMS_FEATURE_NOT_SUPPORTED_INCONSISTENT

public static final EEbmsError EBMS_FEATURE_NOT_SUPPORTED_INCONSISTENT

EBMS_INVALID_HEADER

public static final EEbmsError EBMS_INVALID_HEADER

EBMS_PROCESSING_MODE_MISMATCH

public static final EEbmsError EBMS_PROCESSING_MODE_MISMATCH

EBMS_EXTERNAL_PAYLOAD_ERROR

public static final EEbmsError EBMS_EXTERNAL_PAYLOAD_ERROR

EBMS_FAILED_AUTHENTICATION

public static final EEbmsError EBMS_FAILED_AUTHENTICATION

EBMS_FAILED_DECRYPTION

public static final EEbmsError EBMS_FAILED_DECRYPTION

EBMS_POLICY_NONCOMPLIANCE

public static final EEbmsError EBMS_POLICY_NONCOMPLIANCE

EBMS_DYSFUNCTIONAL_RELIABILITY

public static final EEbmsError EBMS_DYSFUNCTIONAL_RELIABILITY

EBMS_DELIVERY_FAILURE

public static final EEbmsError EBMS_DELIVERY_FAILURE

EBMS_MISSING_RECEIPT

public static final EEbmsError EBMS_MISSING_RECEIPT

EBMS_INVALID_RECEIPT

public static final EEbmsError EBMS_INVALID_RECEIPT

EBMS_DECOMPRESSION_FAILURE

public static final EEbmsError EBMS_DECOMPRESSION_FAILURE

Method Detail

values

public static EEbmsError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EEbmsError c : EEbmsError.values())
    System.out.println(c);

Returns:

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

valueOf

public static EEbmsError 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

getErrorCode

@Nonnull
public String getErrorCode()

Description copied from interface: IEbmsError

Gets the value of the errorCode property.

Specified by:

getErrorCode in interface IEbmsError

Returns:

possible object is String

getSeverity

@Nonnull
public EEbmsErrorSeverity getSeverity()

Description copied from interface: IEbmsError

Gets the value of the severity property.

Specified by:

getSeverity in interface IEbmsError

Returns:

possible object is String

getShortDescription

@Nonnull
public String getShortDescription()

Description copied from interface: IEbmsError

Gets the value of the shortDescription property.

Specified by:

getShortDescription in interface IEbmsError

Returns:

possible object is String

getErrorDetail

@Nonnull
public com.helger.commons.text.display.IHasDisplayText getErrorDetail()

Description copied from interface: IEbmsError

Gets the value of the errorDetail property.

Specified by:

getErrorDetail in interface IEbmsError

Returns:

possible object is String

getCategory

@Nonnull
public EEbmsErrorCategory getCategory()

Description copied from interface: IEbmsError

Gets the value of the category property.

Specified by:

getCategory in interface IEbmsError

Returns:

possible object is EEbmsErrorCategory

getFromErrorCodeOrNull

@Nullable
public static EEbmsError getFromErrorCodeOrNull(@Nullable
                                                           String sErrorCode)

getFromIErrorOrNull

@Nullable
public static EEbmsError getFromIErrorOrNull(@Nullable
                                                        com.helger.commons.error.IError aError)