org.hawkular.alerts.actions.api

Interface ActionPluginListener

public interface ActionPluginListener

A listener that will initialize the plugin and process incoming messages.

Author:

Lucas Ponce

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getDefaultProperties() The alerts engine registers the plugins available with their default values.
Set<String>	getProperties() The alerts engine registers the plugins available with their properties.
void	process(ActionMessage msg) This method is invoked by the ActionService to process a new action generated by the engine.

Method Detail

getProperties

Set<String> getProperties()

The alerts engine registers the plugins available with their properties. This method is invoked at plugin registration time.

Returns:

a list of properties available on this plugin

getDefaultProperties

Map<String,String> getDefaultProperties()

The alerts engine registers the plugins available with their default values. This method is invoked at plugin registration time. Default values can be modified by the alerts engine.

Returns:

a list of default values for properties available on this plugin

process

void process(ActionMessage msg)
      throws Exception

This method is invoked by the ActionService to process a new action generated by the engine.

Parameters:

msg - PluginMessage received to be processed by the plugin

Throws:

Exception - any problem