org.hawkular.alerts.api.model.condition

Class EventCondition

java.lang.Object

org.hawkular.alerts.api.model.condition.Condition

org.hawkular.alerts.api.model.condition.EventCondition

All Implemented Interfaces:

Serializable

public class EventCondition
extends Condition

An EventCondition is used for condition evaluations over Event data using expressions.

 Expression is a comma separated list of the following 3-token structure:

  <eventField> <operator> <constant> [,<eventField> <operator> <constant>]* 

  <eventField> represents a fixed field of the Event structure, or a tag key.
 Supported eventFields:
   - tenantId (String)
   - id (String)
   - ctime (Numeric time since epoch in milliseconds)
   - text (String)
   - category (String)
   - tags. (String)

  <operator> is a string representing a string/numeric operator.
 Supported operators:
   "starts" starts with String
   "ends" ends with String
   "contains" contains String
   "match" regex match String
   "==" equals
   "!=" not equals
   "<" less than
   "<=" less than or equals
   ">" greater than
   ">=" greater than or equals

 A String  <constant> must be enclosed in single-quotes. Special characters must be
 escaped with a backslash. Examples: 'test', '\,test\\'

 A Numeric  <constant> must be a valid number. Examples: 0, 23, 90.5, -10

 Example of a valid expression:
 id starts 'IDXYZ', category == 'Server', tags.from ends '.com'

 An invalid expression will always return false.
 

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hawkular.alerts.api.model.condition.Condition

Condition.Type

Field Summary

Fields inherited from class org.hawkular.alerts.api.model.condition.Condition

conditionId, conditionSetIndex, conditionSetSize, context, tenantId, triggerId, triggerMode, type

Constructor Summary

Constructors

Constructor and Description
EventCondition()
EventCondition(String triggerId, Mode triggerMode, int conditionSetSize, int conditionSetIndex, String dataId, String expression) This constructor requires the tenantId be assigned prior to persistence.
EventCondition(String triggerId, Mode triggerMode, String dataId, String expression) This constructor requires the tenantId be assigned prior to persistence.
EventCondition(String tenantId, String triggerId, int conditionSetSize, int conditionSetIndex, String dataId)
EventCondition(String tenantId, String triggerId, int conditionSetSize, int conditionSetIndex, String dataId, String expression)
EventCondition(String tenantId, String triggerId, Mode triggerMode, int conditionSetSize, int conditionSetIndex, String dataId)
EventCondition(String tenantId, String triggerId, Mode triggerMode, int conditionSetSize, int conditionSetIndex, String dataId, String expression)
EventCondition(String tenantId, String triggerId, Mode triggerMode, String dataId)
EventCondition(String tenantId, String triggerId, Mode triggerMode, String dataId, String expression)
EventCondition(String tenantId, String triggerId, String dataId, String expression)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDataId()
String	getExpression()
String	getLog(Event value)
int	hashCode()
boolean	match(Event value)
void	setDataId(String dataId)
void	setExpression(String expression)
String	toString()

Methods inherited from class org.hawkular.alerts.api.model.condition.Condition

getConditionId, getConditionSetIndex, getConditionSetSize, getContext, getTenantId, getTriggerId, getTriggerMode, getType, setConditionSetIndex, setConditionSetSize, setContext, setTenantId, setTriggerId, setTriggerMode

Methods inherited from class java.lang.Object

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

Constructor Detail

EventCondition

public EventCondition()

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      String dataId,
                      String expression)

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      Mode triggerMode,
                      String dataId)

EventCondition

public EventCondition(String triggerId,
                      Mode triggerMode,
                      String dataId,
                      String expression)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      Mode triggerMode,
                      String dataId,
                      String expression)

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      int conditionSetSize,
                      int conditionSetIndex,
                      String dataId)

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      int conditionSetSize,
                      int conditionSetIndex,
                      String dataId,
                      String expression)

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      Mode triggerMode,
                      int conditionSetSize,
                      int conditionSetIndex,
                      String dataId)

EventCondition

public EventCondition(String triggerId,
                      Mode triggerMode,
                      int conditionSetSize,
                      int conditionSetIndex,
                      String dataId,
                      String expression)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

EventCondition

public EventCondition(String tenantId,
                      String triggerId,
                      Mode triggerMode,
                      int conditionSetSize,
                      int conditionSetIndex,
                      String dataId,
                      String expression)

Method Detail

setDataId

public void setDataId(String dataId)

getLog

public String getLog(Event value)

getDataId

public String getDataId()

Specified by:

getDataId in class Condition

Returns:

The dataId, can be null if the Condition has no relevant dataId.

getExpression

public String getExpression()

setExpression

public void setExpression(String expression)

match

public boolean match(Event value)

equals

public boolean equals(Object o)

Overrides:

equals in class Condition

hashCode

public int hashCode()

Overrides:

hashCode in class Condition

toString

public String toString()

Overrides:

toString in class Condition