org.hawkular.alerts.api.services

Interface DefinitionsService

public interface DefinitionsService

A interface used to create new triggers, conditions and init new notifiers. Implementation should manage the persistence of the definitions.

Author:

Jay Shaughnessy, Lucas Ponce

Method Summary

Modifier and Type	Method and Description
void	addAction(String tenantId, String actionPlugin, String actionId, Map<String,String> properties) Create a new Action
void	addActionPlugin(String actionPlugin, Map<String,String> defaultProperties) Add a new Plugin into definitions service.
void	addActionPlugin(String actionPlugin, Set<String> properties) Add a new Plugin into the definitions service.
Collection<Condition>	addCondition(String tenantId, String triggerId, Trigger.Mode triggerMode, Condition condition) A convenience method that adds a new Condition to the existing condition set for the specified Trigger and trigger mode.
Dampening	addDampening(String tenantId, Dampening dampening)
void	addTag(String tenantId, Tag tag) Add Tag to the specified Trigger (tenantId+triggerid).
void	addTrigger(String tenantId, Trigger trigger) Create a new Trigger.
Trigger	copyTrigger(String tenantId, String triggerId, Map<String,String> dataIdMap) Used to generate an explicit Trigger from a Tokenized Trigger.
Map<String,String>	getAction(String tenantId, String actionPlugin, String actionId)
Set<String>	getActionPlugin(String actionPlugin) Get list of properties needed to configure an action for a specific plugin
Collection<String>	getActionPlugins() Get all list of plugins configured on the system.
Map<String,Set<String>>	getActions(String tenantId)
Collection<String>	getActions(String tenantId, String actionPlugin)
Map<String,Map<String,Set<String>>>	getAllActions()
Collection<Condition>	getAllConditions()
Collection<Dampening>	getAllDampenings()
Collection<Trigger>	getAllTriggers() Get all stored Triggers for all Tenants
Collection<Trigger>	getAllTriggersByTag(String category, String name) Get all stored Triggers for all Tenants with a specific Tag.
Condition	getCondition(String tenantId, String conditionId)
Collection<Condition>	getConditions(String tenantId)
Dampening	getDampening(String tenantId, String dampeningId)
Collection<Dampening>	getDampenings(String tenantId)
Map<String,String>	getDefaultActionPlugin(String actionPlugin) Get a map with the properties needed to configure an action with its default values
Trigger	getTrigger(String tenantId, String triggerId) Get a stored Trigger for a specific Tenant.
Collection<Condition>	getTriggerConditions(String tenantId, String triggerId, Trigger.Mode triggerMode)
Collection<Dampening>	getTriggerDampenings(String tenantId, String triggerId, Trigger.Mode triggerMode)
Collection<Trigger>	getTriggers(String tenantId) Get all stored Triggers for a specific Tenant.
Collection<Trigger>	getTriggersByTag(String tenantId, String category, String name) Get all stored Triggers with a specific Tag.
List<Tag>	getTriggerTags(String tenantId, String triggerId, String category)
void	registerListener(DefinitionsListener listener, DefinitionsEvent.EventType eventType, DefinitionsEvent.EventType... eventTypes)
void	removeAction(String tenantId, String actionPlugin, String actionId)
void	removeActionPlugin(String actionPlugin) Remove an existing Plugin from the definitions service.
Collection<Condition>	removeCondition(String tenantId, String conditionId) A convenience method that removes a Condition from an existing condition set.
void	removeDampening(String tenantId, String dampeningId)
void	removeTags(String tenantId, String triggerId, String category, String name) Delete tag(s) for the specified trigger, optionally filtered by category and/or name.
void	removeTrigger(String tenantId, String triggerId) The Trigger will be removed from the Alerts engine, as needed, and will no longer be persisted.
Collection<Condition>	setConditions(String tenantId, String triggerId, Trigger.Mode triggerMode, Collection<Condition> conditions) The condition set for a trigger's trigger mode is treated as a whole.
void	updateAction(String tenantId, String actionPlugin, String actionId, Map<String,String> properties)
void	updateActionPlugin(String actionPlugin, Map<String,String> defaultProperties) Update an existing plugin.
void	updateActionPlugin(String actionPlugin, Set<String> properties) Update an existing plugin.
Collection<Condition>	updateCondition(String tenantId, Condition condition) A convenience method that updates an existing Condition from an existing condition set.
Dampening	updateDampening(String tenantId, Dampening dampening)
Trigger	updateTrigger(String tenantId, Trigger trigger) Update the Trigger.

Method Detail

addTrigger

void addTrigger(String tenantId,
                Trigger trigger)
         throws Exception

Create a new Trigger. Conditions and Actions are manipulated in separate calls. The new Trigger will be persisted. When fully defined a call to updateTrigger(String, Trigger) is needed to enable the Trigger.

Parameters:

tenantId - Tenant where trigger is created

trigger - New trigger definition to be added

Throws:

Exception - If the Trigger already exists.

removeTrigger

void removeTrigger(String tenantId,
                   String triggerId)
            throws Exception

The Trigger will be removed from the Alerts engine, as needed, and will no longer be persisted.

Parameters:

tenantId - Tenant where trigger is stored

triggerId - Trigger to be removed

Throws:

Exception - on any problem

updateTrigger

Trigger updateTrigger(String tenantId,
                      Trigger trigger)
               throws Exception

Update the Trigger. Conditions and Actions are manipulated in separate calls. The updated Trigger will be persisted. If enabled the Trigger will be [re-]inserted into the Alerts engine and any prior dampening will be reset.

Parameters:

tenantId - Tenant where trigger is updated

trigger - Existing trigger to be updated

Throws:

Exception - If the Trigger does not exist.

getTrigger

Trigger getTrigger(String tenantId,
                   String triggerId)
            throws Exception

Get a stored Trigger for a specific Tenant.

Parameters:

tenantId - Tenant where trigger is stored

triggerId - Given trigger to be retrieved

Throws:

Exception - on any problem

getTriggers

Collection<Trigger> getTriggers(String tenantId)
                         throws Exception

Get all stored Triggers for a specific Tenant.

Parameters:

tenantId - Tenant where triggers are stored

Throws:

Exception - on any problem

getTriggersByTag

Collection<Trigger> getTriggersByTag(String tenantId,
                                     String category,
                                     String name)
                              throws Exception

Get all stored Triggers with a specific Tag. Category and Name can not both be null.

Parameters:

tenantId - Tenant where trigger is stored

category - The tag category, if null or empty fetch only by tag name

name - The tag name, if null or empty fetch only by tag category

Throws:

Exception - on any problem

getAllTriggers

Collection<Trigger> getAllTriggers()
                            throws Exception

Get all stored Triggers for all Tenants

Throws:

Exception - on any problem

getAllTriggersByTag

Collection<Trigger> getAllTriggersByTag(String category,
                                        String name)
                                 throws Exception

Get all stored Triggers for all Tenants with a specific Tag. This can be inefficient, especially if querying by name only.

Parameters:

category - The tag category, if null or empty fetch only by tag name

name - The tag name, required

Throws:

Exception - on any problem

copyTrigger

Trigger copyTrigger(String tenantId,
                    String triggerId,
                    Map<String,String> dataIdMap)
             throws Exception

Used to generate an explicit Trigger from a Tokenized Trigger. The dataIdMap replaces the tokens in the Conditions with actual dataIds.

Parameters:

tenantId - Tenant where trigger is stored

triggerId - Trigger to be copied

dataIdMap - Tokens to be replaced in the new trigger

Returns:

a copy of original trigger

Throws:

Exception - on any problem

addDampening

Dampening addDampening(String tenantId,
                       Dampening dampening)
                throws Exception

Throws:

Exception

removeDampening

void removeDampening(String tenantId,
                     String dampeningId)
              throws Exception

Throws:

Exception

updateDampening

Dampening updateDampening(String tenantId,
                          Dampening dampening)
                   throws Exception

Throws:

Exception

getDampening

Dampening getDampening(String tenantId,
                       String dampeningId)
                throws Exception

Throws:

Exception

getTriggerDampenings

Collection<Dampening> getTriggerDampenings(String tenantId,
                                           String triggerId,
                                           Trigger.Mode triggerMode)
                                    throws Exception

Parameters:

tenantId - Tenant where trigger is stored

triggerId - Given trigger

triggerMode - Return only dampenings for the given trigger mode. Return all if null.

Returns:

The existing dampenings for the trigger. Not null.

Throws:

Exception - on any problem

getAllDampenings

Collection<Dampening> getAllDampenings()
                                throws Exception

Returns:

The existing dampenings stored under a tenant

Throws:

Exception - on any problem

getDampenings

Collection<Dampening> getDampenings(String tenantId)
                             throws Exception

Parameters:

tenantId - Tenant where dampening are stored

Returns:

The existing dampenings stored under a tenant

Throws:

Exception - on any problem

addCondition

Collection<Condition> addCondition(String tenantId,
                                   String triggerId,
                                   Trigger.Mode triggerMode,
                                   Condition condition)
                            throws Exception

A convenience method that adds a new Condition to the existing condition set for the specified Trigger and trigger mode. The new condition will be assigned the highest conditionSetIndex for the updated conditionSet. The following Condition fields are ignored for the incoming condition, and set in the returned collection set:

   conditionId
   triggerId
   triggerMode
   conditionSetSize
   conditionSetIndex
 

Parameters:

tenantId - Tenant where trigger is stored

triggerId - Trigger where condition will be stored

triggerMode - Mode where condition is applied

condition - Not null

Returns:

The updated, persisted condition set

Throws:

Exception - on any problem

removeCondition

Collection<Condition> removeCondition(String tenantId,
                                      String conditionId)
                               throws Exception

A convenience method that removes a Condition from an existing condition set. This will update the conditionSetSize and possibly the conditionSetIndex for any remaining conditions.

Parameters:

tenantId - Tenant where trigger and his conditions are stored

conditionId - Condition id to be removed

Returns:

The updated, persisted condition set. Not null. Can be empty.

Throws:

Exception - on any problem

updateCondition

Collection<Condition> updateCondition(String tenantId,
                                      Condition condition)
                               throws Exception

A convenience method that updates an existing Condition from an existing condition set.

Parameters:

tenantId -

condition - Not null. conditionId must be for an existing condition.

Returns:

The updated, persisted condition set. Not null. Can be empty.

Throws:

Exception - on any problem

setConditions

Collection<Condition> setConditions(String tenantId,
                                    String triggerId,
                                    Trigger.Mode triggerMode,
                                    Collection<Condition> conditions)
                             throws Exception

The condition set for a trigger's trigger mode is treated as a whole. When making any change to the conditions just [re-]set all of the conditions. The following Condition fields are ignored for the incoming conditions, and set in the returned collection:

   conditionId
   triggerId
   triggerMode
   conditionSetSize
   conditionSetIndex
 

Parameters:

tenantId - Tenant where trigger and his conditions are stored

triggerId - Trigger where conditions will be stored

triggerMode - Mode where conditions are applied

conditions - Not null, Not Empty

Returns:

The persisted condition set

Throws:

Exception - on any problem

getCondition

Condition getCondition(String tenantId,
                       String conditionId)
                throws Exception

Throws:

Exception

getTriggerConditions

Collection<Condition> getTriggerConditions(String tenantId,
                                           String triggerId,
                                           Trigger.Mode triggerMode)
                                    throws Exception

Parameters:

tenantId - Tenant where trigger and his conditions are stored

triggerId - Trigger where conditions are stored

triggerMode - Return only conditions for the given trigger mode. Return all if null.

Returns:

The existing conditions for the trigger. Not null.

Throws:

Exception - on any problem

getConditions

Collection<Condition> getConditions(String tenantId)
                             throws Exception

Throws:

Exception

getAllConditions

Collection<Condition> getAllConditions()
                                throws Exception

Throws:

Exception

addActionPlugin

void addActionPlugin(String actionPlugin,
                     Set<String> properties)
              throws Exception

Add a new Plugin into the definitions service. This operation is invoked mainly on a registration plugin phase. A new plugin is deployed into hawkular and it registers his name and properties name. Properties have to be filled when a new action is created.

Parameters:

actionPlugin - name of the plugin

properties - list of properties to be configured in actions of this plugins type

Throws:

Exception - on any problem

addActionPlugin

void addActionPlugin(String actionPlugin,
                     Map<String,String> defaultProperties)
              throws Exception

Add a new Plugin into definitions service. This operation is invoked mainly on a registration plugin phase. A new plugin is deployed into hawkular and it register his name, his properties and also defines default values for those properties. Properties are overwritten per action but default values are used in case some property is not present.

Parameters:

actionPlugin - name of the plugin

defaultProperties - map of properties with its default values

Throws:

Exception - on any problem

removeActionPlugin

void removeActionPlugin(String actionPlugin)
                 throws Exception

Remove an existing Plugin from the definitions service.

Parameters:

actionPlugin - name of the plugin

Throws:

Exception - on any problem

updateActionPlugin

void updateActionPlugin(String actionPlugin,
                        Set<String> properties)
                 throws Exception

Update an existing plugin. This operation changes the properties needed for a plugin.

Parameters:

actionPlugin - name of the plugin

properties - list of properties to be configured in actions of this plugins type

Throws:

Exception - on any problem

updateActionPlugin

void updateActionPlugin(String actionPlugin,
                        Map<String,String> defaultProperties)
                 throws Exception

Update an existing plugin. This operation changes the properties needed for a plugin and its default values.

Parameters:

actionPlugin - name of the plugin

defaultProperties - map of properties with its default values

Throws:

Exception - on any problem

getActionPlugins

Collection<String> getActionPlugins()
                             throws Exception

Get all list of plugins configured on the system.

Returns:

List of plugins configured on the definitions service

Throws:

Exception - on an problem

getActionPlugin

Set<String> getActionPlugin(String actionPlugin)
                     throws Exception

Get list of properties needed to configure an action for a specific plugin

Parameters:

actionPlugin - name of the plugin

Returns:

list of properties to be configured

Throws:

Exception - on any problem

getDefaultActionPlugin

Map<String,String> getDefaultActionPlugin(String actionPlugin)
                                   throws Exception

Get a map with the properties needed to configure an action with its default values

Parameters:

actionPlugin - name of the plugin

Returns:

map of properties with its default values

Throws:

Exception - on any problem

addAction

void addAction(String tenantId,
               String actionPlugin,
               String actionId,
               Map<String,String> properties)
        throws Exception

Create a new Action

Parameters:

tenantId - Tenant where actions are stored

actionPlugin - Action plugin where this action is stored

actionId - Id of new action

properties - the properties of the action

Throws:

Exception - on any problem

removeAction

void removeAction(String tenantId,
                  String actionPlugin,
                  String actionId)
           throws Exception

Throws:

Exception

updateAction

void updateAction(String tenantId,
                  String actionPlugin,
                  String actionId,
                  Map<String,String> properties)
           throws Exception

Throws:

Exception

getAllActions

Map<String,Map<String,Set<String>>> getAllActions()
                                           throws Exception

Returns:

Map where key is a tenantId and value is a Map with actionPlugin as key and a set of actionsId as value

Throws:

Exception - on any problem

getActions

Map<String,Set<String>> getActions(String tenantId)
                            throws Exception

Parameters:

tenantId - Tenant where actions are stored.

Returns:

Map where key represents an actionPlugin and value a Set of actionsId per actionPlugin

Throws:

Exception - on any problem

getActions

Collection<String> getActions(String tenantId,
                              String actionPlugin)
                       throws Exception

Throws:

Exception

getAction

Map<String,String> getAction(String tenantId,
                             String actionPlugin,
                             String actionId)
                      throws Exception

Throws:

Exception

addTag

void addTag(String tenantId,
            Tag tag)
     throws Exception

Add Tag to the specified Trigger (tenantId+triggerid). Category is optional but highly recommended for efficiency and to avoid unwanted name collisions. If the Tag exists the call returns successfully but has no effect.

Parameters:

tenantId - Tenant where tag is created

tag - New tag to be created

Throws:

Exception - on any problem

removeTags

void removeTags(String tenantId,
                String triggerId,
                String category,
                String name)
         throws Exception

Delete tag(s) for the specified trigger, optionally filtered by category and/or name.

Parameters:

triggerId - NotEmpty

category - Nullable

name - Nullable

Throws:

Exception - on any problem

getTriggerTags

List<Tag> getTriggerTags(String tenantId,
                         String triggerId,
                         String category)
                  throws Exception

Parameters:

tenantId - NotEmpty, must be the proper tenant for the specified trigger.

triggerId - NotEmpty

category - Nullable.

Returns:

The existing Tags for the trigger, optionally filtered by category. Sorted by category, name.

Throws:

Exception - on any problem

registerListener

void registerListener(DefinitionsListener listener,
                      DefinitionsEvent.EventType eventType,
                      DefinitionsEvent.EventType... eventTypes)