org.broadleafcommerce.common.event

Enum BroadleafSystemEvent.BroadleafEventScopeType

java.lang.Object

java.lang.Enum<BroadleafSystemEvent.BroadleafEventScopeType>

org.broadleafcommerce.common.event.BroadleafSystemEvent.BroadleafEventScopeType

All Implemented Interfaces:

Serializable, Comparable<BroadleafSystemEvent.BroadleafEventScopeType>

Enclosing class:

BroadleafSystemEvent

public static enum BroadleafSystemEvent.BroadleafEventScopeType
extends Enum<BroadleafSystemEvent.BroadleafEventScopeType>

Constant for how the event should be consumed

Author:

Jay Aisenbrey (cja769)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DURABLE_GLOBAL Durable events are always global, but are not removed from the system, allowing them to be consumed across server restarts, or when new nodes enter the cluster (VM level events already exhibit behavior that allow them to execute even after system restarts and do not require additional "durable" classification).
GLOBAL All nodes will execute
LOCAL Consume the event locally only
NON_ASYNC_LOCAL Consume the event locally only in the same thread
NON_ASYNC_LOCAL_NO_RESUME Consume the event locally only in the same thread and do not allow auto resume
VM Limit execution to a single, arbitrary node

Method Summary

Modifier and Type	Method and Description
static BroadleafSystemEvent.BroadleafEventScopeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BroadleafSystemEvent.BroadleafEventScopeType[]	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

Enum Constant Detail

GLOBAL

public static final BroadleafSystemEvent.BroadleafEventScopeType GLOBAL

All nodes will execute

VM

public static final BroadleafSystemEvent.BroadleafEventScopeType VM

Limit execution to a single, arbitrary node

LOCAL

public static final BroadleafSystemEvent.BroadleafEventScopeType LOCAL

Consume the event locally only

NON_ASYNC_LOCAL

public static final BroadleafSystemEvent.BroadleafEventScopeType NON_ASYNC_LOCAL

Consume the event locally only in the same thread

NON_ASYNC_LOCAL_NO_RESUME

public static final BroadleafSystemEvent.BroadleafEventScopeType NON_ASYNC_LOCAL_NO_RESUME

Consume the event locally only in the same thread and do not allow auto resume

DURABLE_GLOBAL

public static final BroadleafSystemEvent.BroadleafEventScopeType DURABLE_GLOBAL

Durable events are always global, but are not removed from the system, allowing them to be consumed across server restarts, or when new nodes enter the cluster (VM level events already exhibit behavior that allow them to execute even after system restarts and do not require additional "durable" classification). Supports 'playback' of a group of events that need to 'catch up' to events that it might have missed

Method Detail

values

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

Returns:

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

valueOf

public static BroadleafSystemEvent.BroadleafEventScopeType 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