org.codice.ddf.system.alerts

Class Alert

java.lang.Object

org.codice.ddf.system.alerts.SystemNotice

org.codice.ddf.system.alerts.Alert

public class Alert
extends SystemNotice

Alert is the property map class used by DDF for alerting events. When events are received on the Decanter topic 'decanter/alert/*' by the AlertListener they are converted to this class for storage and dissemination. This class defines all the common keys used in alerts events that are not included in the SystemNotice class and provides convenient helpers for accessing them.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERT_ACTIVE_STATUS
static String	ALERT_COUNT Key for the integer count indicating how many times this alert has occurred
static String	ALERT_DISMISS_TOPIC
static String	ALERT_DISMISSED_BY Key for the user who dismissed the alert
static String	ALERT_DISMISSED_STATUS
static String	ALERT_DISMISSED_TIME Key for the data/time this alert was dismissed
static String	ALERT_EVENT_TYPE
static String	ALERT_LAST_UPDATED Key for the date/time when this alert was last updated
static String	ALERT_STATUS Key for the status of this alert, either acitve or dismissed

Fields inherited from class org.codice.ddf.system.alerts.SystemNotice

EVENT_TYPE_KEY, properties, SYSTEM_NOTICE_BASE_TOPIC, SYSTEM_NOTICE_DETAILS_KEY, SYSTEM_NOTICE_EVENT_TYPE, SYSTEM_NOTICE_HOST_ADDRESS_KEY, SYSTEM_NOTICE_HOST_NAME_KEY, SYSTEM_NOTICE_ID_KEY, SYSTEM_NOTICE_PRIORITY_KEY, SYSTEM_NOTICE_SOURCE_KEY, SYSTEM_NOTICE_TIME_KEY, SYSTEM_NOTICE_TITLE_KEY

Constructor Summary

Constructors

Constructor and Description
Alert()
Alert(Map<String,Object> map)
Alert(String source, NoticePriority priority, String title, Set<String> details)

Method Summary

Modifier and Type	Method and Description
Long	getCount()
Alert	getDismissedAlert(String user)
String	getDismissedBy()
Date	getDismissedTime()
Date	getLastUpdated()
String	getStatus()
protected void	init()

Methods inherited from class org.codice.ddf.system.alerts.SystemNotice

getDetails, getHostAddress, getHostName, getId, getPriority, getProperties, getSource, getTime, getTitle, safePut

Methods inherited from class java.lang.Object

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

Field Detail

ALERT_DISMISS_TOPIC

public static final String ALERT_DISMISS_TOPIC

See Also:

Constant Field Values

ALERT_EVENT_TYPE

public static final String ALERT_EVENT_TYPE

See Also:

Constant Field Values

ALERT_LAST_UPDATED

public static final String ALERT_LAST_UPDATED

Key for the date/time when this alert was last updated

See Also:

Constant Field Values

ALERT_COUNT

public static final String ALERT_COUNT

Key for the integer count indicating how many times this alert has occurred

See Also:

Constant Field Values

ALERT_STATUS

public static final String ALERT_STATUS

Key for the status of this alert, either acitve or dismissed

See Also:

Constant Field Values

ALERT_DISMISSED_TIME

public static final String ALERT_DISMISSED_TIME

Key for the data/time this alert was dismissed

See Also:

Constant Field Values

ALERT_DISMISSED_BY

public static final String ALERT_DISMISSED_BY

Key for the user who dismissed the alert

See Also:

Constant Field Values

ALERT_DISMISSED_STATUS

public static final String ALERT_DISMISSED_STATUS

See Also:

Constant Field Values

ALERT_ACTIVE_STATUS

public static final String ALERT_ACTIVE_STATUS

See Also:

Constant Field Values

Constructor Detail

Alert

public Alert()

Alert

public Alert(String source,
             NoticePriority priority,
             String title,
             Set<String> details)

Alert

public Alert(Map<String,Object> map)

Method Detail

init

protected void init()

Overrides:

init in class SystemNotice

getLastUpdated

public Date getLastUpdated()

getCount

public Long getCount()

getStatus

public String getStatus()

getDismissedTime

public Date getDismissedTime()

getDismissedBy

public String getDismissedBy()

getDismissedAlert

public Alert getDismissedAlert(String user)