Package alpine.event.framework

Interface Event

All Known Subinterfaces:

ChainableEvent, UnblockedEvent

All Known Implementing Classes:

AbstractChainableEvent, LdapSyncEvent, SingletonCapableEvent

public interface Event

The Event interface simply defines a 'type'. All Events should implement this interface.

Since:

1.0.0

Author:

Steve Springett

Method Summary

Static Methods

Modifier and Type	Method	Description
static void	dispatch(Event event)	The dispath method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event.
static boolean	isEventBeingProcessed(ChainableEvent event)	This method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event.
static boolean	isEventBeingProcessed(UUID chainIdentifier)	This method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event.

Method Details

dispatch

static void dispatch(Event event)

The dispath method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event. This method supports both EventService and SingleThreadedEventService and may send an event to zero or more of the event services if they have a subscriber capable of processing the event.

Parameters:

event - the event to dispatch

Since:

1.2.0

isEventBeingProcessed

static boolean isEventBeingProcessed(ChainableEvent event)

This method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event. This method supports both EventService and SingleThreadedEventService.

Parameters:

event - the event to query

Returns:

returns true if event is being processed, false if not

Since:

1.4.0

isEventBeingProcessed

static boolean isEventBeingProcessed(UUID chainIdentifier)

This method provides convenience in not having to know (or care) about what IEventService implementation is used to process an event. This method supports both EventService and SingleThreadedEventService.

Parameters:

chainIdentifier - the UUID of the event to query

Returns:

returns true if event is being processed, false if not

Since:

1.4.0