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, Mode triggerMode, Condition condition) Deprecated. use setConditions(String, String, Mode, Collection)
Dampening	addDampening(String tenantId, Dampening dampening) Add the Dampening.
Dampening	addGroupDampening(String tenantId, Dampening groupDampening) Add the Dampening.
void	addGroupTrigger(String tenantId, Trigger groupTrigger) Create a new Group Trigger.
Trigger	addMemberTrigger(String tenantId, String groupId, String memberId, String memberName, Map<String,String> memberContext, Map<String,String> dataIdMap) Generate a member trigger for the specified group trigger.
void	addTrigger(String tenantId, Trigger trigger) Create a new 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 name, String value) Get all stored Triggers for all Tenants with a specific Tag.
Condition	getCondition(String tenantId, String conditionId) Deprecated.
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
Collection<Trigger>	getMemberTriggers(String tenantId, String groupId, boolean includeOrphans) Get the member triggers for the specified group trigger.
Trigger	getTrigger(String tenantId, String triggerId) Get a stored Trigger for a specific Tenant.
Collection<Condition>	getTriggerConditions(String tenantId, String triggerId, Mode triggerMode)
Collection<Dampening>	getTriggerDampenings(String tenantId, String triggerId, Mode triggerMode)
Page<Trigger>	getTriggers(String tenantId, TriggersCriteria criteria, Pager pager)
Trigger	orphanMemberTrigger(String tenantId, String memberId) Orphan a member trigger.
void	registerListener(DefinitionsListener listener, DefinitionsEvent.Type eventType, DefinitionsEvent.Type... 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) Deprecated. use setConditions(String, String, Mode, Collection)
void	removeDampening(String tenantId, String dampeningId) Remove the specified Dampening from the relevant trigger.
void	removeGroupDampening(String tenantId, String groupDampeningId) Remove the specified Dampening from the relevant group trigger.
void	removeGroupTrigger(String tenantId, String groupId, boolean keepNonOrphans, boolean keepOrphans) The group Trigger will be removed from the Alerts engine, as needed, and will no longer be persisted.
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, Mode triggerMode, Collection<Condition> conditions) The condition set for a trigger's trigger mode is treated as a whole.
Collection<Condition>	setGroupConditions(String tenantId, String groupId, Mode triggerMode, Collection<Condition> groupConditions, Map<String,Map<String,String>> dataIdMemberMap) The condition set for the specified Group Trigger and trigger mode.
Trigger	unorphanMemberTrigger(String tenantId, String memberId, Map<String,String> memberContext, Map<String,String> dataIdMap) Un-orphan a member trigger.
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) Deprecated. use setConditions(String, String, Mode, Collection)
Dampening	updateDampening(String tenantId, Dampening dampening) Update the Dampening on the relevant trigger.
Dampening	updateGroupDampening(String tenantId, Dampening groupDampening) Update the Dampening on the relevant group trigger.
Trigger	updateGroupTrigger(String tenantId, Trigger groupTrigger) Update the group Trigger.
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 Dampening 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.

A non-group trigger can never be made into a group trigger, and vice-versa.

Parameters:

tenantId - Tenant where trigger is created

trigger - New trigger definition to be added

Throws:

Exception - If the Trigger already exists.

See Also:

#addGroupTrigger(String, Trigger)} for adding a group trigger.

addGroupTrigger

void addGroupTrigger(String tenantId,
                     Trigger groupTrigger)
              throws Exception

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

A non-group trigger can never be made into a group trigger, and vice-versa.

Parameters:

tenantId - Tenant where trigger is created

groupTrigger - New trigger definition to be added

Throws:

Exception - If the Trigger already exists.

See Also:

#addTrigger(String, Trigger)} for adding a non-group trigger.

addMemberTrigger

Trigger addMemberTrigger(String tenantId,
                         String groupId,
                         String memberId,
                         String memberName,
                         Map<String,String> memberContext,
                         Map<String,String> dataIdMap)
                  throws Exception

Generate a member trigger for the specified group trigger. See org.hawkular.alerts.api.json.MemberTrigger#setDataIdMap(Map) for an example of the dataIdMap parameter. The member trigger gets the enabled state of the group.

Parameters:

tenantId - Tenant where trigger is stored

groupId - Group triggerId from which to spawn the member trigger

memberId - The member triggerId, unique id within the tenant, if null an Id will be generated

memberName - The member triggerName, not null, unique name within the tenant

memberContext - The member triggerContext. If null the context is inherited from the group trigger

dataIdMap - Tokens to be replaced in the new trigger

Returns:

the member trigger

Throws:

Exception - on any problem

See Also:

#addTrigger(String, Trigger)} for adding a non-group trigger., #addGroupTrigger(String, Trigger)} for adding a group trigger., org.hawkular.alerts.api.json.MemberTrigger#setDataIdMap(Map)} for an example of the dataIdMap parameter.

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:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#removeGroupTrigger(String, String, boolean, boolean)} for removing a group trigger and its members.

removeGroupTrigger

void removeGroupTrigger(String tenantId,
                        String groupId,
                        boolean keepNonOrphans,
                        boolean keepOrphans)
                 throws Exception

The group Trigger will be removed from the Alerts engine, as needed, and will no longer be persisted. The member triggers will be removed as well, depending on the settings for keepNonOrphans and keepOrphans. Note that any member triggers not removed will no longer have a group trigger associated and will then need to be managed independently.

Parameters:

tenantId - Tenant where trigger is stored

groupId - Group Trigger to be removed.

keepNonOrphans - If true the non-orphan member are maintained and made independent.

keepOrphans - If true the orphan member triggers are maintained and made independent.

Throws:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#removeTrigger(String, String)} for removing a non-group trigger

updateTrigger

Trigger updateTrigger(String tenantId,
                      Trigger trigger)
               throws Exception

Update the Trigger. Conditions and Dampening 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:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#updateGroupTrigger(String, Trigger)} for updating a group trigger

updateGroupTrigger

Trigger updateGroupTrigger(String tenantId,
                           Trigger groupTrigger)
                    throws Exception

Update the group Trigger. Conditions and Dampening 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.

The group's non-orphan member triggers will be similarly updated.

Parameters:

tenantId - Tenant where trigger is updated

groupTrigger - Existing trigger to be updated

Throws:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#updateTrigger(String, Trigger)} for updating a non-group trigger.

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

Page<Trigger> getTriggers(String tenantId,
                          TriggersCriteria criteria,
                          Pager pager)
                   throws Exception

Parameters:

tenantId - Tenant where triggers are stored

criteria - If null returns all triggers for the tenant (not recommended)

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

Returns:

NotNull, can be empty.

Throws:

Exception - any problem

getMemberTriggers

Collection<Trigger> getMemberTriggers(String tenantId,
                                      String groupId,
                                      boolean includeOrphans)
                               throws Exception

Get the member triggers for the specified group trigger.

Parameters:

tenantId - Tenant for the group trigger

groupId - Group triggerId

includeOrphans - if true, include orphan triggers for the group

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 name,
                                        String value)
                                 throws Exception

Get all stored Triggers for all Tenants with a specific Tag. This can be inefficient.

Parameters:

name - The tag name, not null.

value - The tag value, not null. Set to '*' to match all values for the name.

Throws:

Exception - on any problem

orphanMemberTrigger

Trigger orphanMemberTrigger(String tenantId,
                            String memberId)
                     throws Exception

Orphan a member trigger. The member trigger will no longer inherit group updates. It will be allowed to be independently updated. It does maintain its group reference and can again be tied to the group via a call to unorphanMemberTrigger(String, String, Map, Map).

Parameters:

tenantId - Tenant where trigger is stored

memberId - The member triggerId

Returns:

the member trigger

Throws:

NotFoundException - if trigger is not found

Exception

See Also:

#unorphanMemberTrigger(String, String, Map, Map)} to again have the trigger be a full group member.

unorphanMemberTrigger

Trigger unorphanMemberTrigger(String tenantId,
                              String memberId,
                              Map<String,String> memberContext,
                              Map<String,String> dataIdMap)
                       throws Exception

Un-orphan a member trigger. The member trigger is again synchronized with the group definition. As an orphan it may have been altered in various ways. So, as when spawning a new member trigger, the context and dataIdMap are specified. See org.hawkular.alerts.api.json.MemberTrigger#setDataIdMap(Map) for an example of setting the dataIdMap.

This is basically a convenience method that first performs a removeTrigger(String, String) and then an addMemberTrigger(String, String, String, String, Map, Map). But the member trigger must already exist for this call to succeed. The trigger will maintain the same group, id, and name.

Parameters:

tenantId - Tenant where trigger is stored

memberId - The member triggerId

memberContext - The member triggerContext. If null the context is inherited from the member trigger

dataIdMap - Tokens to be replaced in the new trigger

Returns:

the member trigger

Throws:

NotFoundException - if trigger is not found

Exception

See Also:

#orphanMemberTrigger(String, String)} for setting a member to be an orphan., org.hawkular.alerts.api.json.MemberTrigger#setDataIdMap(Map)} for an example of setting the dataIdMap.

addDampening

Dampening addDampening(String tenantId,
                       Dampening dampening)
                throws Exception

Add the Dampening. The relevant triggerId is specified in the Dampening object.

Parameters:

tenantId - the owning tenant

dampening - the Dampening definition, which should be tied to a trigger

Returns:

the new Dampening

Throws:

Exception

See Also:

#addGroupDampening(String, Dampening)} for adding group-level dampening

addGroupDampening

Dampening addGroupDampening(String tenantId,
                            Dampening groupDampening)
                     throws Exception

Add the Dampening. The relevant triggerId is specified in the Dampening object.

The group's non-orphan member triggers will be similarly updated.

Parameters:

tenantId - the owning tenant

groupDampening - the Dampening definition, which should be tied to a trigger

Returns:

the new Dampening

Throws:

Exception

See Also:

#addDampening(String, Dampening)} for adding non-group dampening.

removeDampening

void removeDampening(String tenantId,
                     String dampeningId)
              throws Exception

Remove the specified Dampening from the relevant trigger.

Parameters:

tenantId - the owning tenant

dampeningId - the doomed dampening record

Throws:

Exception

See Also:

#removeGroupDampening(String, String)} for removing group-level dampening.

removeGroupDampening

void removeGroupDampening(String tenantId,
                          String groupDampeningId)
                   throws Exception

Remove the specified Dampening from the relevant group trigger.

The group's non-orphan member triggers will be similarly updated.

Parameters:

tenantId - the owning tenant

groupDampeningId - the doomed dampening record for the group trigger

Throws:

Exception

See Also:

#removeDampening(String, String)} for removing non-group dampening.

updateDampening

Dampening updateDampening(String tenantId,
                          Dampening dampening)
                   throws Exception

Update the Dampening on the relevant trigger.

Parameters:

tenantId - the owning tenant

dampening - the Dampening definition, which should be tied to a trigger

Returns:

the new Dampening

Throws:

Exception

See Also:

#updateGroupDampening(String, Dampening)} for group-level dampening.

updateGroupDampening

Dampening updateGroupDampening(String tenantId,
                               Dampening groupDampening)
                        throws Exception

Update the Dampening on the relevant group trigger.

The group's non-orphan member triggers will be similarly updated.

Parameters:

tenantId - the owning tenant

groupDampening - the Dampening definition, which should be tied to a group trigger

Returns:

the new Dampening

Throws:

Exception

See Also:

#updateDampening(String, Dampening)} for non-group dampening.

getDampening

Dampening getDampening(String tenantId,
                       String dampeningId)
                throws Exception

Throws:

Exception

getTriggerDampenings

Collection<Dampening> getTriggerDampenings(String tenantId,
                                           String triggerId,
                                           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

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

Deprecated. use setConditions(String, String, Mode, Collection)

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.

IMPORTANT! Add/Delete/Update of a condition effectively replaces the condition set for the trigger. The new condition set is returned. Clients code should then use the new condition set as ConditionIds may have changed!

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:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#addGroupCondition(String, String, Mode, Condition, Map)} for group-level conditions.

removeCondition

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

Deprecated. use setConditions(String, String, Mode, Collection)

A convenience method that removes a Condition from an existing condition set.

IMPORTANT! Add/Delete/Update of a condition effectively replaces the condition set for the trigger. The new condition set is returned. Clients code should then use the new condition set as ConditionIds may have changed!

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

See Also:

#removeGroupCondition(String, String)} for group-level conditions.

updateCondition

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

Deprecated. use setConditions(String, String, Mode, Collection)

A convenience method that updates an existing condition.

IMPORTANT! Add/Delete/Update of a condition effectively replaces the condition set for the trigger. The new condition set is returned. Clients code should then use the new condition set as ConditionIds may have changed!

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

See Also:

#updateGroupCondition(String, Condition)} for group-level conditions.

setConditions

Collection<Condition> setConditions(String tenantId,
                                    String triggerId,
                                    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.

IMPORTANT! Add/Delete/Update of a condition effectively replaces the condition set for the trigger. The new condition set is returned. Clients code should then use the new condition set as ConditionIds may have changed!

The following Condition fields are ignored for the incoming conditions, and set in the returned collection:

   conditionId
   triggerId
   triggerMode
   conditionSetSize
   conditionSetIndex
 

Note that due to the complexity of adding group-level conditions, it is only supported to add or remove a single group condition at one time. So there is no setGroupConditions. Instead, use #addGroupCondition(String, String, Mode, Condition, Map) and #removeGroupCondition(String, String) as needed.

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

See Also:

#removeGroupCondition(String, String)} to remove a group condition., #addGroupCondition(String, String, Mode, Condition, Map)} to add a group condition.

setGroupConditions

Collection<Condition> setGroupConditions(String tenantId,
                                         String groupId,
                                         Mode triggerMode,
                                         Collection<Condition> groupConditions,
                                         Map<String,Map<String,String>> dataIdMemberMap)
                                  throws Exception

The condition set for the specified Group Trigger and trigger mode. The set conditions are ordered using the Collection ordering as the conditionSet ordering (assuming an ordered Collection implementation is supplied). Any existing conditions are replaced. The non-orphan member triggers will have the new condition set applied, using the provided dataIdMemberMap. See org.hawkular.alerts.api.json.GroupConditions#setDataIdMemberMap(Map) for an example of the dataIdMemberMap parameter. The following Condition fields are ignored for the incoming conditions, and set in the returned collection set:

   conditionId
   triggerId
   triggerMode
   conditionSetSize
   conditionSetIndex
 

Parameters:

tenantId - Tenant where trigger is stored

groupId - Group Trigger adding the condition and whose non-orphan members will also have it added.

triggerMode - Mode where condition is applied

groupCondition - Not null, the condition to add

dataIdMemberMap - see above for details.

Returns:

The updated, persisted condition set for the group

Throws:

NotFoundException - if trigger is not found

Exception - on any problem

See Also:

#addCondition(String, String, Mode, Condition)} for non-group conditions., org.hawkular.alerts.api.json.MemberCondition#setDataIdMemberMap(Map)} for an example of the dataIdMemberMap parameter.

getCondition

@Deprecated
Condition getCondition(String tenantId,
                                    String conditionId)
                             throws Exception

Deprecated.

Throws:

Exception

getTriggerConditions

Collection<Condition> getTriggerConditions(String tenantId,
                                           String triggerId,
                                           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

registerListener

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