com.neeve.aep
Enum AepEngine.MessagingStartFailPolicy

java.lang.Object
  java.lang.Enum<AepEngine.MessagingStartFailPolicy>
      com.neeve.aep.AepEngine.MessagingStartFailPolicy

All Implemented Interfaces:

Serializable, Comparable<AepEngine.MessagingStartFailPolicy>

Enclosing class:

AepEngine

public static enum AepEngine.MessagingStartFailPolicy
extends Enum<AepEngine.MessagingStartFailPolicy>

Enumerates an engine's messaging start fail policy.

The messaging start operation establishes the bindings to the various buses that an engine is configured to bind to. This enumeration enumerates the policy that determines the conditions under which a messaging start operation is considered to have failed.

The NeverFail option causes a start operation to be considered successful as long as all bind attempts do not result in permanent exceptions (a permanent exception reported by a bind attempt causes the bind operation to not be retried while a non-permanent exception causes the bind attempt to be periodically retried). In other words, the NeverFail option causes a messaging start operation to be reported as successful as long as at least one bind attempt was successful or failed with a non-permanent exception.

Enum Constant Summary

FailIfAllBindingsFail
This policy causes a messaging start operation to be considered successful if one or more binding attempts is successful i.e. with this option, a messaging start operation is reported as failed if all the binding attempts fail.

FailIfOneBindingFails
This policy causes a messaging start operation to be considered successful only if all bindings attempts are successful i.e. with this option a messaging start operation is reported as failed if one or more of the binding attempts fails.

NeverFail
This policy causes a start operation to be considered successful as long as all bind attempts do not result in permanent exceptions (a permanent exception reported by a bind attempt causes the bind operation to not be retried while a non-permanent exception causes the bind attempt to be periodically retried).

Method Summary

static AepEngine.MessagingStartFailPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static AepEngine.MessagingStartFailPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NeverFail

public static final AepEngine.MessagingStartFailPolicy NeverFail

This policy causes a start operation to be considered successful as long as all bind attempts do not result in permanent exceptions (a permanent exception reported by a bind attempt causes the bind operation to not be retried while a non-permanent exception causes the bind attempt to be periodically retried). In other words, the NeverFail option causes a messaging start operation to be reported as successful as long as at least one bind attempt was successful or failed with a non-permanent exception.

FailIfOneBindingFails

public static final AepEngine.MessagingStartFailPolicy FailIfOneBindingFails

This policy causes a messaging start operation to be considered successful only if all bindings attempts are successful i.e. with this option a messaging start operation is reported as failed if one or more of the binding attempts fails.

This is the default messaging start fail policy

FailIfAllBindingsFail

public static final AepEngine.MessagingStartFailPolicy FailIfAllBindingsFail

This policy causes a messaging start operation to be considered successful if one or more binding attempts is successful i.e. with this option, a messaging start operation is reported as failed if all the binding attempts fail.

Method Detail

values

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

Returns:

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

valueOf

public static AepEngine.MessagingStartFailPolicy 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