org.hawkular.alerts.api.services

Interface ActionsService

public interface ActionsService

A interface used to send actions. Actions will be created inside of the alerts engine and will be delivered using a chain of ActionListener listeners.

Author:

Jay Shaughnessy, Lucas Ponce

Method Summary

Modifier and Type	Method and Description
void	addListener(ActionListener listener) Register a listener that will process actions.
int	deleteActions(String tenantId, ActionsCriteria criteria) Delete the requested Actions from the history, as described by the provided criteria.
Page<Action>	getActions(String tenantId, ActionsCriteria criteria, Pager pager)
void	send(Trigger trigger, Event event) Generate and send an action to be processed by the plugins architecture.
void	updateResult(Action action) Update the result of an action.

Method Detail

send

void send(Trigger trigger,
          Event event)

Generate and send an action to be processed by the plugins architecture.

Parameters:

trigger - Trigger generating the action

event - Event payload of the action

updateResult

void updateResult(Action action)

Update the result of an action.

Parameters:

action - Action

getActions

Page<Action> getActions(String tenantId,
                        ActionsCriteria criteria,
                        Pager pager)
                 throws Exception

Parameters:

tenantId - Tenant where actions are stored

criteria - If null returns all actions (not recommended)

pager - Paging requirement for fetching actions. Optional. Return all if null.

Returns:

NotNull, can be empty.

Throws:

Exception - on any problem

deleteActions

int deleteActions(String tenantId,
                  ActionsCriteria criteria)
           throws Exception

Delete the requested Actions from the history, as described by the provided criteria.

Parameters:

tenantId - Tenant where actions are stored

criteria - If null deletes all actions (not recommended)

Returns:

number of actions deleted

Throws:

Exception - on any problem

addListener

void addListener(ActionListener listener)

Register a listener that will process actions. ActionListeners are responsible to connect Actions with plugins.

Parameters:

listener - the listener