com.helger.as2lib.disposition

Class DispositionType

java.lang.Object

com.helger.as2lib.disposition.DispositionType

@Immutable
public class DispositionType
extends Object

Contains the disposition type for creating the MDN. That one determines if a message processed successfully or not.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_AUTOMATIC_ACTION
static String	MDNACTION_MDN_SENT_AUTOMATICALLY
static String	STATUS_MODIFIER_ERROR
static String	STATUS_MODIFIER_WARNING
static String	STATUS_PROCESSED

Constructor Summary

Constructors

Constructor and Description
DispositionType(String sAction, String sMDNAction, String sStatus, String sStatusModifier, String sStatusDescription)

Method Summary

Modifier and Type	Method and Description
static DispositionType	createError(String sStatusDescription)
static DispositionType	createFromString(String sDisposition)
static DispositionType	createSuccess()
String	getAction()
String	getAsString()
String	getMDNAction()
String	getStatus()
String	getStatusDescription()
String	getStatusModifier()
boolean	isError()
boolean	isWarning()
String	toString()
void	validate(IMessage aSrcMsg, String sText) Throws a AS2DispositionException if the message is a warning or an error.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_AUTOMATIC_ACTION

public static final String ACTION_AUTOMATIC_ACTION

See Also:

Constant Field Values

MDNACTION_MDN_SENT_AUTOMATICALLY

public static final String MDNACTION_MDN_SENT_AUTOMATICALLY

See Also:

Constant Field Values

STATUS_PROCESSED

public static final String STATUS_PROCESSED

See Also:

Constant Field Values

STATUS_MODIFIER_ERROR

public static final String STATUS_MODIFIER_ERROR

See Also:

Constant Field Values

STATUS_MODIFIER_WARNING

public static final String STATUS_MODIFIER_WARNING

See Also:

Constant Field Values

Constructor Detail

DispositionType

public DispositionType(@Nonnull
                       String sAction,
                       @Nonnull
                       String sMDNAction,
                       @Nonnull
                       String sStatus,
                       @Nullable
                       String sStatusModifier,
                       @Nullable
                       String sStatusDescription)

Method Detail

getAction

@Nonnull
public final String getAction()

getMDNAction

@Nonnull
public final String getMDNAction()

getStatus

@Nonnull
public final String getStatus()

getStatusDescription

@Nullable
public final String getStatusDescription()

getStatusModifier

@Nullable
public final String getStatusModifier()

isError

public boolean isError()

Returns:

true if it is an error, false if not (maybe success or warning).

isWarning

public boolean isWarning()

Returns:

true if it is a warning, false if not (maybe success or error).

validate

public void validate(@Nonnull
                     IMessage aSrcMsg,
                     @Nonnull
                     String sText)
              throws AS2DispositionException

Throws a AS2DispositionException if the message is a warning or an error. If the disposition is fine this method simply returns.

Parameters:

aSrcMsg - The source message. May not be null.

sText - The disposition text to use. May not be null.

Throws:

AS2DispositionException - The checked exception.

Since:

4.10.0 this method has parameters

getAsString

@Nonnull
public String getAsString()

toString

public String toString()

Overrides:

toString in class Object

createFromString

@Nonnull
public static DispositionType createFromString(@Nullable
                                                         String sDisposition)
                                                  throws AS2Exception

Throws:

AS2Exception

createSuccess

@Nonnull
public static DispositionType createSuccess()

Returns:

A success disposition without additional information. Never null.

createError

@Nonnull
public static DispositionType createError(@Nonnull
                                                    String sStatusDescription)

Parameters:

sStatusDescription - The status description to be used. May not be null.

Returns:

An error disposition with the modifier STATUS_MODIFIER_ERROR and the provided status description.