com.helger.phase4.model

Enum EMEPBinding

java.lang.Object

java.lang.Enum<EMEPBinding>

com.helger.phase4.model.EMEPBinding

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EMEPBinding>

public enum EMEPBinding
extends Enum<EMEPBinding>
implements com.helger.commons.id.IHasID<String>

Predefines transport channel bindings.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
PULL maps an MEP User message to the second leg of an underlying two-way transport protocol, as a result of an ebMS Pull Signal sent over the first leg.
PULL_PUSH The Two-Way/Pull-and-Push MEP composes the choreography of a One-Way/Pull MEP followed by the choreography of a One-Way/Push MEP, with both MEPs initiated from the same MSH.
PUSH maps an MEP User message to the 1st leg of an underlying 2-way transport protocol, or of a 1-way protocol.
PUSH_PULL The Two-Way/Push-and-Pull MEP composes the choreography of a One-Way/Push MEP followed by the choreography of a One-Way/Pull MEP, both initiated from the same MSH (Initiator).
PUSH_PUSH The Two-Way/Push-and-Push MEP composes the choreographies of two One-Way/Push MEPs in opposite directions, the User Message unit of the second referring to the User Message unit of the first via eb:RefToMessageId.
SYNC maps an exchange of two User messages respectively to the first and second legs of a two-way underlying transport protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static EMEPBinding	DEFAULT_EBMS

Method Summary

Modifier and Type	Method and Description
boolean	canSendUserMessageBack()
static EMEPBinding	getFromIDOrNull(String sID)
static EMEPBinding	getFromURIOrNull(String sURI)
String	getID()
int	getRequiredLegs()
String	getURI()
boolean	isAsynchronous()
boolean	isAsynchronousInitiator()
boolean	isSynchronous()
static EMEPBinding	valueOf(String name) Returns the enum constant of this type with the specified name.
static EMEPBinding[]	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.commons.id.IHasID

getComparatorID

Enum Constant Detail

PUSH

public static final EMEPBinding PUSH

maps an MEP User message to the 1st leg of an underlying 2-way transport protocol, or of a 1-way protocol.

PULL

public static final EMEPBinding PULL

maps an MEP User message to the second leg of an underlying two-way transport protocol, as a result of an ebMS Pull Signal sent over the first leg.

SYNC

public static final EMEPBinding SYNC

maps an exchange of two User messages respectively to the first and second legs of a two-way underlying transport protocol.

PUSH_PUSH

public static final EMEPBinding PUSH_PUSH

The Two-Way/Push-and-Push MEP composes the choreographies of two One-Way/Push MEPs in opposite directions, the User Message unit of the second referring to the User Message unit of the first via eb:RefToMessageId.

PUSH_PULL

public static final EMEPBinding PUSH_PULL

The Two-Way/Push-and-Pull MEP composes the choreography of a One-Way/Push MEP followed by the choreography of a One-Way/Pull MEP, both initiated from the same MSH (Initiator). The User Message unit in the "pulled" message must refer to the previously "pushed" User Message unit.

PULL_PUSH

public static final EMEPBinding PULL_PUSH

The Two-Way/Pull-and-Push MEP composes the choreography of a One-Way/Pull MEP followed by the choreography of a One-Way/Push MEP, with both MEPs initiated from the same MSH. The User Message unit in the "pushed" message must refer to the previously "pulled" User Message unit.

Field Detail

DEFAULT_EBMS

public static final EMEPBinding DEFAULT_EBMS

Method Detail

values

public static EMEPBinding[] 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 (EMEPBinding c : EMEPBinding.values())
    System.out.println(c);

Returns:

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

valueOf

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

getURI

@Nonnull
 @Nonempty
public String getURI()

getRequiredLegs

@Nonnegative
public int getRequiredLegs()

isSynchronous

public boolean isSynchronous()

Returns:

true if the processing is synchronous (PUSH, PULL or SYNC), false otherwise.

See Also:

isAsynchronous()

isAsynchronous

public boolean isAsynchronous()

Returns:

true if the processing is asynchronous (PUSH_PUSH, PUSH_PULL or PULL_PUSH), false otherwise.

See Also:

isSynchronous()

isAsynchronousInitiator

public boolean isAsynchronousInitiator()

Returns:

true if initiator side has the asynchronous part of the transfer (this == PUSH_PULL || this == PULL_PUSH)

canSendUserMessageBack

public boolean canSendUserMessageBack()

getFromIDOrNull

@Nullable
public static EMEPBinding getFromIDOrNull(@Nullable
                                                     String sID)

getFromURIOrNull

@Nullable
public static EMEPBinding getFromURIOrNull(@Nullable
                                                      String sURI)