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 actionId, Map<String,String> properties)
void	addActionPlugin(String actionPlugin, Set<String> properties)
Collection<Condition>	addCondition(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(Dampening dampening)
void	addTag(Tag tag) Add Tag with the specified name to the specified Trigger.
void	addTrigger(Trigger trigger) Create a new Trigger.
Trigger	copyTrigger(String triggerId, Map<String,String> dataIdMap) Used to generate an explicit Trigger from a Tokenized Trigger.
Map<String,String>	getAction(String actionId)
Set<String>	getActionPlugin(String actionPlugin)
Collection<String>	getActionPlugins()
Collection<String>	getActions(String actionPlugin)
Collection<String>	getAllActions()
Collection<Condition>	getAllConditions()
Collection<Dampening>	getAllDampenings()
Collection<Trigger>	getAllTriggers()
Condition	getCondition(String conditionId)
Dampening	getDampening(String dampeningId)
Trigger	getTrigger(String triggerId)
Collection<Condition>	getTriggerConditions(String triggerId, Trigger.Mode triggerMode)
Collection<Dampening>	getTriggerDampenings(String triggerId, Trigger.Mode triggerMode)
List<Tag>	getTriggerTags(String triggerId, String category)
void	registerListener(DefinitionsListener listener)
void	removeAction(String actionId)
void	removeActionPlugin(String actionPlugin)
Collection<Condition>	removeCondition(String conditionId) A convenience method that removes a Condition from an existing condition set.
void	removeDampening(String dampeningId)
void	removeTags(String triggerId, String category, String name) Delete tag(s) for the specified trigger, optionally filtered by category and/or name.
void	removeTrigger(String triggerId) The Trigger will be removed from the Alerts engine, as needed, and will no longer be persisted.
Collection<Condition>	setConditions(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 actionId, Map<String,String> properties)
void	updateActionPlugin(String actionPlugin, Set<String> properties)
Collection<Condition>	updateCondition(Condition condition) A convenience method that updates an existing Condition from an existing condition set.
Dampening	updateDampening(Dampening dampening)
Trigger	updateTrigger(Trigger trigger) Update the Trigger.

Method Detail

addTrigger

void addTrigger(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(Trigger) is needed to enable the Trigger.

Parameters:

trigger - the trigger

Throws:

Exception - If the Trigger already exists.

removeTrigger

void removeTrigger(String triggerId)
            throws Exception

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

Parameters:

triggerId - the triggerId

Throws:

Exception - on any problem

updateTrigger

Trigger updateTrigger(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:

trigger - the trigger

Returns:

the updated Trigger

Throws:

Exception - If the Trigger does not exist.

getTrigger

Trigger getTrigger(String triggerId)
            throws Exception

Throws:

Exception

getAllTriggers

Collection<Trigger> getAllTriggers()
                            throws Exception

Throws:

Exception

copyTrigger

Trigger copyTrigger(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:

triggerId - the triggerId

dataIdMap - the dataIdMap

Returns:

The copy

Throws:

Exception - on any problem

addDampening

Dampening addDampening(Dampening dampening)
                throws Exception

Throws:

Exception

removeDampening

void removeDampening(String dampeningId)
              throws Exception

Throws:

Exception

updateDampening

Dampening updateDampening(Dampening dampening)
                   throws Exception

Throws:

Exception

getDampening

Dampening getDampening(String dampeningId)
                throws Exception

Throws:

Exception

getTriggerDampenings

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

Parameters:

triggerId - the triggerId

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

Throws:

Exception

addCondition

Collection<Condition> addCondition(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:

triggerId - the triggerId

triggerMode - the triggerMode

condition - Not null

Returns:

The updated, persisted condition set

Throws:

Exception - on any problem

removeCondition

Collection<Condition> removeCondition(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:

conditionId - the conditionId

Returns:

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

Throws:

Exception - on any problem

updateCondition

Collection<Condition> updateCondition(Condition condition)
                               throws Exception

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

Parameters:

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 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:

triggerId - the triggerId

triggerMode - the triggerMode

conditions - Not null, Not Empty

Returns:

The persisted condition set

Throws:

Exception - on any problem

getCondition

Condition getCondition(String conditionId)
                throws Exception

Throws:

Exception

getTriggerConditions

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

Parameters:

triggerId - the triggerId

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

getAllConditions

Collection<Condition> getAllConditions()
                                throws Exception

Throws:

Exception

addActionPlugin

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

Throws:

Exception

removeActionPlugin

void removeActionPlugin(String actionPlugin)
                 throws Exception

Throws:

Exception

updateActionPlugin

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

Throws:

Exception

getActionPlugins

Collection<String> getActionPlugins()
                             throws Exception

Throws:

Exception

getActionPlugin

Set<String> getActionPlugin(String actionPlugin)
                     throws Exception

Throws:

Exception

addAction

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

Throws:

Exception

removeAction

void removeAction(String actionId)
           throws Exception

Throws:

Exception

updateAction

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

Throws:

Exception

getAllActions

Collection<String> getAllActions()
                          throws Exception

Throws:

Exception

getActions

Collection<String> getActions(String actionPlugin)
                       throws Exception

Throws:

Exception

getAction

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

Throws:

Exception

addTag

void addTag(Tag tag)
     throws Exception

Add Tag with the specified name to the specified Trigger. Category is optional. If the Tag exists the call returns successfully but has no effect.

Parameters:

tag - the tag

Throws:

Exception - on any problem

removeTags

void removeTags(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 triggerId,
                         String category)
                  throws Exception

Parameters:

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)