org.openhubframework.openhub.spi.alerts

Class AlertInfo

java.lang.Object

org.openhubframework.openhub.spi.alerts.AlertInfo

All Implemented Interfaces:

HumanReadable

public class AlertInfo
extends Object
implements HumanReadable

Alert entity.

Since:

0.4

Author:

Petr Juza

Constructor Summary

Constructors

Constructor and Description
AlertInfo(String id, long limit, String sql, boolean enabled, String notificationSubject, String notificationBody) Creates new alert.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId() Gets alert unique identification.
long	getLimit() Gets limit.
String	getNotificationBody() Gets notification (email, sms) body.
String	getNotificationSubject() Gets notification (email, sms) subject.
String	getSql() Gets SQL expression.
int	hashCode()
boolean	isEnabled() Is this alert enabled?
void	setEnabled(boolean enabled) Enables/disables this alert.
void	setLimit(long limit) Sets limit.
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertInfo

public AlertInfo(String id,
         long limit,
         String sql,
         boolean enabled,
         @Nullable
         String notificationSubject,
         @Nullable
         String notificationBody)

Creates new alert.

Parameters:

id - the alert unique identification

limit - limit that must be exceeded to activate alert

sql - SQL query that returns count of items for comparison with limit value

enabled - if specified alert is enabled or disabled

notificationSubject - the (mail, sms) subject

notificationBody - the (mail, sms) body

Method Detail

getId

public String getId()

Gets alert unique identification.

Returns:

alert identification

getLimit

public long getLimit()

Gets limit.

Returns:

limit

setLimit

public void setLimit(long limit)

Sets limit.

Parameters:

limit - the limit

getSql

public String getSql()

Gets SQL expression.

Returns:

SQL expression

isEnabled

public boolean isEnabled()

Is this alert enabled?

Returns:

true if enabled otherwise false

setEnabled

public void setEnabled(boolean enabled)

Enables/disables this alert.

Parameters:

enabled - true for enabling otherwise false

getNotificationSubject

@Nullable
public String getNotificationSubject()

Gets notification (email, sms) subject.

Returns:

subject

getNotificationBody

@Nullable
public String getNotificationBody()

Gets notification (email, sms) body.

Returns:

body

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toHumanString

public String toHumanString()

Description copied from interface: HumanReadable

Returns human readable entity identification with start and end round brackets.

Specified by:

toHumanString in interface HumanReadable

Returns:

entity identification

toString

public String toString()

Overrides:

toString in class Object