org.hawkular.alerts.api.model.action

Class ActionDefinition

java.lang.Object

org.hawkular.alerts.api.model.action.ActionDefinition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Action

public class ActionDefinition
extends Object
implements Serializable

An action is the abstract concept of ta consequence of an event. Actions are processed by plugins, and plugins offer a map of properties to personalize an action. An ActionDefinition stores which properties will be used for a specific action in a specific plugin. A Trigger definition can be linked with a list of action definitions. Alert engine will instantiate a specific Action based on its ActionDefinition.

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionDefinition()
ActionDefinition(String tenantId, String actionPlugin, String actionId)
ActionDefinition(String tenantId, String actionPlugin, String actionId, Map<String,String> properties)
ActionDefinition(String tenantId, String actionPlugin, String actionId, Map<String,String> properties, Set<String> states, TimeConstraint calendar)

Method Summary

Modifier and Type	Method and Description
void	addState(String state)
boolean	equals(Object o)
String	getActionId()
String	getActionPlugin()
TimeConstraint	getCalendar()
Map<String,String>	getProperties()
Set<String>	getStates()
String	getTenantId()
int	hashCode()
void	setActionId(String actionId)
void	setActionPlugin(String actionPlugin)
void	setCalendar(TimeConstraint calendar)
void	setProperties(Map<String,String> properties)
void	setStates(Set<String> states)
void	setTenantId(String tenantId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionDefinition

public ActionDefinition()

ActionDefinition

public ActionDefinition(String tenantId,
                        String actionPlugin,
                        String actionId)

ActionDefinition

public ActionDefinition(String tenantId,
                        String actionPlugin,
                        String actionId,
                        Map<String,String> properties)

ActionDefinition

public ActionDefinition(String tenantId,
                        String actionPlugin,
                        String actionId,
                        Map<String,String> properties,
                        Set<String> states,
                        TimeConstraint calendar)

Method Detail

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)

getActionPlugin

public String getActionPlugin()

setActionPlugin

public void setActionPlugin(String actionPlugin)

getActionId

public String getActionId()

setActionId

public void setActionId(String actionId)

getProperties

public Map<String,String> getProperties()

setProperties

public void setProperties(Map<String,String> properties)

getStates

public Set<String> getStates()

setStates

public void setStates(Set<String> states)

addState

public void addState(String state)

getCalendar

public TimeConstraint getCalendar()

setCalendar

public void setCalendar(TimeConstraint calendar)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object