org.hawkular.alerts.engine.service

Interface AlertsEngine

All Known Implementing Classes:

AlertsEngineImpl

public interface AlertsEngine

Interface that allows to send data to the alerts engine and check resulting state.

Author:

Jay Shaughnessy, Lucas Ponce

Method Summary

Modifier and Type	Method and Description
void	addTrigger(String tenantId, String triggerId) Notify AlertsEngine that a new trigger is going to be loaded.
void	clear() Reset session state.
Trigger	getLoadedTrigger(Trigger trigger)
void	reload() Reload all Triggers.
void	reloadTrigger(String tenantId, String triggerId) Reload the specified Trigger.
void	removeTrigger(String tenantId, String triggerId) Remove the specified Trigger from the engine.
void	sendData(Collection<Data> data) Send data into the alerting system for evaluation.
void	sendData(Data data) Send data into the alerting system for evaluation.
void	sendEvent(Event event) Send event into the alerting system for evaluation.
void	sendEvents(Collection<Event> events) Send event into the alerting system for evaluation.

Method Detail

clear

void clear()

Reset session state.

getLoadedTrigger

Trigger getLoadedTrigger(Trigger trigger)

Parameters:

trigger - the trigger for which the loaded version is requested.

Returns:

the Trigger with the current engine state, or null if the trigger is not found in the engine

sendData

void sendData(Data data)
       throws Exception

Send data into the alerting system for evaluation.

Parameters:

data - Not Null. The data to be evaluated by the alerting engine.

Throws:

Exception - any problem.

sendData

void sendData(Collection<Data> data)
       throws Exception

Send data into the alerting system for evaluation.

Parameters:

data - Not Null. The data to be evaluated by the alerting engine.

Throws:

Exception - any problem.

sendEvent

void sendEvent(Event event)
        throws Exception

Send event into the alerting system for evaluation. Events are persisted after inference.

Parameters:

event - Not Null. The events to be avaluated and persisted by the alerting engine.

Throws:

Exception - any problem

sendEvents

void sendEvents(Collection<Event> events)
         throws Exception

Send event into the alerting system for evaluation. Events are persisted after inference.

Parameters:

events - Not Null. The events to be avaluated and persisted by the alerting engine.

Throws:

Exception - any problem

reload

void reload()

Reload all Triggers.

addTrigger

void addTrigger(String tenantId,
                String triggerId)

Notify AlertsEngine that a new trigger is going to be loaded. This method is used for distributed scenarios, where the AlertsEngine can distribute the trigger on a node. For non-distributed scenarios, this call has not effect as trigger is loaded on local AlertsEngine on new additions or updates of dampening,conditions or existing triggers.

Parameters:

tenantId - Tenant where Trigger is stored

triggerId - Trigger id to be reloaded

reloadTrigger

void reloadTrigger(String tenantId,
                   String triggerId)

Reload the specified Trigger. Removes any existing definition from the engine. If enabled then loads the firing condition set and dampening. If safetyEnabled then also loads the safety condition set and dampening.

Parameters:

tenantId - Tenant where Trigger is stored

triggerId - Trigger id to be reloaded

removeTrigger

void removeTrigger(String tenantId,
                   String triggerId)

Remove the specified Trigger from the engine.

Parameters:

tenantId - Tenant where Trigger is stored

triggerId - Trigger id to be removed