org.hawkular.alerts.actions.email

Class PluginMessageDescription

java.lang.Object

org.hawkular.alerts.actions.email.PluginMessageDescription

public class PluginMessageDescription
extends Object

Helper class to store Alert data and related descriptions and average data to be used into email freemarker templates. This class unwraps PluginMessage fields to be located at root level for freemarker template.

Author:

Jay Shaughnessy, Lucas Ponce

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginMessageDescription.ConditionDescription Helper inner class to store a Condition with a calculated description.

Field Summary

Fields

Modifier and Type	Field and Description
PluginMessageDescription.ConditionDescription[]	conditions A list of conditions stored with ConditionDescription wrapper class
static String	CONTEXT_PROPERTY_DESCRIPTION Context property "description".
static String	CONTEXT_PROPERTY_DESCRIPTION2 Context property "description".
static String	CONTEXT_PROPERTY_RESOURCE_NAME Context property "resourceName".
static String	CONTEXT_PROPERTY_RESOURCE_TYPE Context property "resourceType".
static String	CONTEXT_PROPERTY_UNIT Context property "unit".

Constructor Summary

Constructors

Constructor and Description
PluginMessageDescription(PluginMessage pm) Unwraps a PluginMessage object as a helper for freemaker templates.

Method Summary

Modifier and Type	Method and Description
String	availability(org.hawkular.alerts.api.model.condition.AvailabilityCondition condition) Create a description for an AvailabilityCondition object.
String	compare(org.hawkular.alerts.api.model.condition.CompareCondition condition) Create a description for an CompareCondition object.
String	external(org.hawkular.alerts.api.model.condition.ExternalCondition condition) Create a description for an ExternalCondition object.
org.hawkular.alerts.api.model.condition.Alert	getAlert()
String	getBaseUrl()
PluginMessageDescription.ConditionDescription[]	getConditions()
org.hawkular.alerts.api.model.dampening.Dampening	getDampening()
String	getDampeningDescription()
String	getEmailSubject()
String	getMessage()
int	getNumConditions()
Map<String,String>	getProps()
String	getStatus()
org.hawkular.alerts.api.model.trigger.Trigger	getTrigger()
String	getTriggerDescription()
String	range(org.hawkular.alerts.api.model.condition.ThresholdRangeCondition condition) Create a description for an ThresholdRangeCondition object.
void	setAlert(org.hawkular.alerts.api.model.condition.Alert alert)
void	setBaseUrl(String baseUrl)
void	setConditions(PluginMessageDescription.ConditionDescription[] conditions)
void	setDampening(org.hawkular.alerts.api.model.dampening.Dampening dampening)
void	setDampeningDescription(String dampeningDescription)
void	setEmailSubject(String emailSubject)
void	setMessage(String message)
void	setNumConditions(int numConditions)
void	setProps(Map<String,String> props)
void	setStatus(String status)
void	setTrigger(org.hawkular.alerts.api.model.trigger.Trigger trigger)
void	setTriggerDescription(String triggerDescription)
String	string(org.hawkular.alerts.api.model.condition.StringCondition condition) Create a description for an StringCondition object.
String	threshold(org.hawkular.alerts.api.model.condition.ThresholdCondition condition) Create a description for an ThresholdCondition object.

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_PROPERTY_RESOURCE_TYPE

public static final String CONTEXT_PROPERTY_RESOURCE_TYPE

Context property "resourceType". Supported at Trigger.getContext() level

See Also:

Constant Field Values

CONTEXT_PROPERTY_RESOURCE_NAME

public static final String CONTEXT_PROPERTY_RESOURCE_NAME

Context property "resourceName". Supported at Trigger.getContext() level

See Also:

Constant Field Values

CONTEXT_PROPERTY_UNIT

public static final String CONTEXT_PROPERTY_UNIT

Context property "unit". Supported at Condition.getContext() level

See Also:

Constant Field Values

CONTEXT_PROPERTY_DESCRIPTION

public static final String CONTEXT_PROPERTY_DESCRIPTION

Context property "description". Supported at Condition.getContext() level

See Also:

Constant Field Values

CONTEXT_PROPERTY_DESCRIPTION2

public static final String CONTEXT_PROPERTY_DESCRIPTION2

Context property "description". Supported at Condition.getContext() level with CompareCondition classes

See Also:

Constant Field Values

conditions

public PluginMessageDescription.ConditionDescription[] conditions

A list of conditions stored with ConditionDescription wrapper class

Constructor Detail

PluginMessageDescription

public PluginMessageDescription(PluginMessage pm)

Unwraps a PluginMessage object as a helper for freemaker templates. It creates description and calculated data for all conditions attached into ConditionEvals inside an alert. It uses Trigger data to generate an email subject description. It support Trigger.context properties: - "resourceType": Description of the type or resource where this trigger is defined i.e. "resourceType": "App Server" - "resourceName": Name of the resource where this trigger is defined i.e. "resourceName": "Localhost" If not Trigger.context properties found, Trigger.name will be used in the email subject description.

Parameters:

pm - the PluginMessage

Method Detail

availability

public String availability(org.hawkular.alerts.api.model.condition.AvailabilityCondition condition)

Create a description for an AvailabilityCondition object. It supports Condition.context properties: - "description": Description of the dataId used for this condition, if not present, description will use dataId literal i.e. "description": "Response Time"

Parameters:

condition - the condition

Returns:

a description to be used on email templates

compare

public String compare(org.hawkular.alerts.api.model.condition.CompareCondition condition)

Create a description for an CompareCondition object. It supports Condition.context properties: - "description": Description of the dataId used for this condition, if not present, description will use dataId literal i.e. "description": "Response Time" - "description2": Description of the data2Id used for this comparition, if not present, description will use data2Id literal i.e. "description2": "Response Time 2"

Parameters:

condition - the condition

Returns:

a description to be used on email templates

external

public String external(org.hawkular.alerts.api.model.condition.ExternalCondition condition)

Create a description for an ExternalCondition object.

Parameters:

condition - the condition

Returns:

a description to be used on email templates

string

public String string(org.hawkular.alerts.api.model.condition.StringCondition condition)

Create a description for an StringCondition object. It supports Condition.context properties: - "description": Description of the dataId used for this condition, if not present, description will use dataId literal i.e. "description": "Response Time"

Parameters:

condition - the condition

Returns:

a description to be used on email templates

threshold

public String threshold(org.hawkular.alerts.api.model.condition.ThresholdCondition condition)

Create a description for an ThresholdCondition object. It supports Condition.context properties: - "description": Description of the dataId used for this condition, if not present, description will use dataId literal i.e. "description": "Response Time" - "unit": Description of the unit used for the threshold, if not present, description will be "threshold" i.e. "unit": "milliseconds"

Parameters:

condition - the condition

Returns:

a description to be used on email templates

range

public String range(org.hawkular.alerts.api.model.condition.ThresholdRangeCondition condition)

Create a description for an ThresholdRangeCondition object. It supports Condition.context properties: - "description": Description of the dataId used for this condition, if not present, description will use dataId literal i.e. "description": "Response Time" - "unit": Description of the unit used for the range, if not present, description will be "range" i.e. "unit": "milliseconds"

Parameters:

condition - the condition

Returns:

a description to be used on email templates

getEmailSubject

public String getEmailSubject()

setEmailSubject

public void setEmailSubject(String emailSubject)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getAlert

public org.hawkular.alerts.api.model.condition.Alert getAlert()

setAlert

public void setAlert(org.hawkular.alerts.api.model.condition.Alert alert)

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getTrigger

public org.hawkular.alerts.api.model.trigger.Trigger getTrigger()

setTrigger

public void setTrigger(org.hawkular.alerts.api.model.trigger.Trigger trigger)

getDampening

public org.hawkular.alerts.api.model.dampening.Dampening getDampening()

setDampening

public void setDampening(org.hawkular.alerts.api.model.dampening.Dampening dampening)

getDampeningDescription

public String getDampeningDescription()

setDampeningDescription

public void setDampeningDescription(String dampeningDescription)

getProps

public Map<String,String> getProps()

setProps

public void setProps(Map<String,String> props)

getNumConditions

public int getNumConditions()

setNumConditions

public void setNumConditions(int numConditions)

getBaseUrl

public String getBaseUrl()

setBaseUrl

public void setBaseUrl(String baseUrl)

getConditions

public PluginMessageDescription.ConditionDescription[] getConditions()

setConditions

public void setConditions(PluginMessageDescription.ConditionDescription[] conditions)

getTriggerDescription

public String getTriggerDescription()

setTriggerDescription

public void setTriggerDescription(String triggerDescription)