com.neeve.solace
Enum SolaceOrphanSubscriptionCheckPolicy

java.lang.Object
  java.lang.Enum<SolaceOrphanSubscriptionCheckPolicy>
      com.neeve.solace.SolaceOrphanSubscriptionCheckPolicy

All Implemented Interfaces:

Serializable, Comparable<SolaceOrphanSubscriptionCheckPolicy>

public enum SolaceOrphanSubscriptionCheckPolicy
extends Enum<SolaceOrphanSubscriptionCheckPolicy>

Enumerates possible 'orphan' subscription checks.

When a solace message bus binding has a queue name specified it is capable of issue guaranteed subscriptions against that queue. When a binding is started it is possible that there may already be existing subscriptions on the queue that don't match those that the application is issuing. Such subscriptions are considered to be 'orphan' subscriptions - presumably those left over from an early session that were not removed.

When the Solace appliance and binding is configured with SEMP over messaging enabled the binding can request a list of the subscriptions on the queue and compare them with those issue by the binding. This class enumerates the possible checks that can be done. NOTE: Orphan subscription checking is currently an experimental feature that is still in incubation. Enabling orphan subscription checks or not recommended for production.

See Also:

SolaceBindingProperties.ENABLE_SEMP_PROPNAME

Enum Constant Summary

Ignore
With this policy enabled the appliance is queried for subscriptions, but no action is taken other than tracing the orphans subscriptions at info level.

LogExceptionAndContinue
With this policy enabled the appliance is queried for subscriptions and if orphands are found an exception is logged.

None
With this policy, the appliance is not queried for subscriptions This is the default policy

NoOrphan
With this policy enabled the appliance is queried for subscriptions and an exception is thrown from the message binding start method.

Method Summary

static SolaceOrphanSubscriptionCheckPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SolaceOrphanSubscriptionCheckPolicy[]	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

None

public static final SolaceOrphanSubscriptionCheckPolicy None

With this policy, the appliance is not queried for subscriptions

This is the default policy

Ignore

public static final SolaceOrphanSubscriptionCheckPolicy Ignore

With this policy enabled the appliance is queried for subscriptions, but no action is taken other than tracing the orphans subscriptions at info level.

One other difference between None and Ignore is the the query subscriptions are reported to a subscription validator if registered.

LogExceptionAndContinue

public static final SolaceOrphanSubscriptionCheckPolicy LogExceptionAndContinue

With this policy enabled the appliance is queried for subscriptions and if orphands are found an exception is logged.

NoOrphan

public static final SolaceOrphanSubscriptionCheckPolicy NoOrphan

With this policy enabled the appliance is queried for subscriptions and an exception is thrown from the message binding start method.

Method Detail

values

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

Returns:

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

valueOf

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