org.hawkular.alerts.engine.service

Interface PartitionManager

All Known Implementing Classes:

PartitionManagerImpl

public interface PartitionManager

Interface that defines an abstract API with the clustering services used by the engine. In a no distributed scenario, a single node holds all triggers to process in the AlertsEngine. In distributed scenarios triggers are partitioned across nodes in a consistent hashing algorithm. PartitionManager is responsible to notify when a trigger has been added, modified, removed, in order to update the AlertsEngine state. PartionManager is responsible to detect changes on the topology to reconfigure the partition of the triggers in a transparent way when a new node is added/removed from the cluster. PartitionManager is also responsible to notify when a new data has been received, in order to deliver to the AlertsEngine node where trigger is active.

Author:

Jay Shaughnessy, Lucas Ponce

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PartitionManager.Operation

Method Summary

Modifier and Type	Method and Description
boolean	isDistributed() Detects if PartitionManager is deployed on a distributed scenario.
void	notifyData(Collection<Data> data) Notify partition manager when a new collection of data has been received.
void	notifyData(Data data) Notify partition manager when a new data has been received.
void	notifyEvent(Event event) Notify partition manager when a new event has been received.
void	notifyEvents(Collection<Event> events) Notify partition manager when a new collection of events has been received.
void	notifyTrigger(PartitionManager.Operation operation, String tenantId, String triggerId) Notify partition manager when a trigger, dampening or condition has been added,updated or removed.
void	registerDataListener(PartitionDataListener dataListener) Register a listener to process patition events linked with data or events.
void	registerTriggerListener(PartitionTriggerListener triggerListener) Register a listener to process partition events linked with triggers.

Method Detail

isDistributed

boolean isDistributed()

Detects if PartitionManager is deployed on a distributed scenario. PartitionManager is always present to the engine, but only active on ha profile like defined on standalone-ha.xml PartitionTriggerListener and PartitionDataListener are ignored on non-distributed scenario. notifyTrigger(org.hawkular.alerts.engine.service.PartitionManager.Operation, java.lang.String, java.lang.String), notifyData(org.hawkular.alerts.api.model.data.Data) and notifyEvent(org.hawkular.alerts.api.model.event.Event) are ignored on non-distributed scenario.

Returns:

true if PartitionManager is distributed. false otherwise

notifyTrigger

void notifyTrigger(PartitionManager.Operation operation,
                   String tenantId,
                   String triggerId)

Notify partition manager when a trigger, dampening or condition has been added,updated or removed. PartitionManager will assign the trigger to a node a will notify all nodes with the change.

Parameters:

operation - type of operation performed on the trigger

tenantId - Tenant where Trigger is stored

triggerId - Trigger id

registerTriggerListener

void registerTriggerListener(PartitionTriggerListener triggerListener)

Register a listener to process partition events linked with triggers.

Parameters:

triggerListener - the listener

notifyData

void notifyData(Data data)

Notify partition manager when a new data has been received.

Parameters:

data - the new data received by the engine

notifyData

void notifyData(Collection<Data> data)

Notify partition manager when a new collection of data has been received.

Parameters:

data - the new data received by the engine

notifyEvent

void notifyEvent(Event event)

Notify partition manager when a new event has been received.

Parameters:

event - the new event received by the engine

notifyEvents

void notifyEvents(Collection<Event> events)

Notify partition manager when a new collection of events has been received.

Parameters:

events - the new events received by the engine

registerDataListener

void registerDataListener(PartitionDataListener dataListener)

Register a listener to process patition events linked with data or events.

Parameters:

dataListener - the listener