Package org.codice.ddf.system.alerts

Class SystemNotice

java.lang.Object

org.codice.ddf.system.alerts.SystemNotice

Direct Known Subclasses:

Alert

public class SystemNotice
extends Object

SystemNotice is the property map class used by DDF collectors when sending system notifications to the Decanter topic 'decanter/collect/*'. This class defines all the common keys used in system notification events and provides convenient helpers for accessing them.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_TYPE_KEY	Key for a type identifier.
protected Map<String,Object>	properties
static final String	SYSTEM_NOTICE_BASE_TOPIC
static final String	SYSTEM_NOTICE_DETAILS_KEY	Key for the Set of details of this notice
static final String	SYSTEM_NOTICE_EVENT_TYPE
static final String	SYSTEM_NOTICE_HOST_ADDRESS_KEY	Key for the host address on which this notice originated
static final String	SYSTEM_NOTICE_HOST_NAME_KEY	Key for the host name on which this notice originated
static final String	SYSTEM_NOTICE_ID_KEY	Key for the notice id.
static final String	SYSTEM_NOTICE_PRIORITY_KEY	Key for the priority of the notice.
static final String	SYSTEM_NOTICE_SOURCE_KEY	Key for the source of this notice.
static final String	SYSTEM_NOTICE_TIME_KEY	Key for the date/time of this notice.
static final String	SYSTEM_NOTICE_TITLE_KEY	Key for the title of the notice.

Constructor Summary

Constructors

Constructor	Description
SystemNotice()
SystemNotice(String source, NoticePriority priority, String title, Set<String> details)
SystemNotice(Map<String,Object> properties)

Method Summary

Modifier and Type	Method	Description
Set<String>	getDetails()
String	getHostAddress()
String	getHostName()
String	getId()
NoticePriority	getPriority()
Map<String,Object>	getProperties()	Gets the SystemNotice properties as a map for eventing.
String	getSource()
Date	getTime()
String	getTitle()
protected void	init()
protected void	safePut(String key, Object obj)

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_NOTICE_BASE_TOPIC

public static final String SYSTEM_NOTICE_BASE_TOPIC

See Also:

• Constant Field Values

SYSTEM_NOTICE_EVENT_TYPE

public static final String SYSTEM_NOTICE_EVENT_TYPE

See Also:

• Constant Field Values

EVENT_TYPE_KEY

public static final String EVENT_TYPE_KEY

Key for a type identifier. Included to be consistent with other decanter events. Will always be system-notice

See Also:

• Constant Field Values

SYSTEM_NOTICE_HOST_NAME_KEY

public static final String SYSTEM_NOTICE_HOST_NAME_KEY

Key for the host name on which this notice originated

See Also:

• Constant Field Values

SYSTEM_NOTICE_HOST_ADDRESS_KEY

public static final String SYSTEM_NOTICE_HOST_ADDRESS_KEY

Key for the host address on which this notice originated

See Also:

• Constant Field Values

SYSTEM_NOTICE_ID_KEY

public static final String SYSTEM_NOTICE_ID_KEY

Key for the notice id. This is an auto generated unique id

See Also:

• Constant Field Values

SYSTEM_NOTICE_TIME_KEY

public static final String SYSTEM_NOTICE_TIME_KEY

Key for the date/time of this notice. This is auto populated on creation

See Also:

• Constant Field Values

SYSTEM_NOTICE_SOURCE_KEY

public static final String SYSTEM_NOTICE_SOURCE_KEY

Key for the source of this notice. Usually this is a class name and possibly followed by an additional discriminator (ie method name)

See Also:

• Constant Field Values

SYSTEM_NOTICE_PRIORITY_KEY

public static final String SYSTEM_NOTICE_PRIORITY_KEY

Key for the priority of the notice. Acceptable values can be found in NoticePriority

See Also:

• Constant Field Values

SYSTEM_NOTICE_TITLE_KEY

public static final String SYSTEM_NOTICE_TITLE_KEY

Key for the title of the notice. Defaults to an empty string

See Also:

• Constant Field Values

SYSTEM_NOTICE_DETAILS_KEY

public static final String SYSTEM_NOTICE_DETAILS_KEY

Key for the Set of details of this notice

See Also:

• Constant Field Values

properties

protected Map<String,Object> properties

Constructor Details

SystemNotice

public SystemNotice()

SystemNotice

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

SystemNotice

public SystemNotice(Map<String,Object> properties)

Method Details

init

protected void init()

getProperties

public Map<String,Object> getProperties()

Gets the SystemNotice properties as a map for eventing.

Returns:

A copy of the internal properties map.

getId

public String getId()

getSource

public String getSource()

getHostName

public String getHostName()

getHostAddress

public String getHostAddress()

getPriority

public NoticePriority getPriority()

getTitle

public String getTitle()

getDetails

public Set<String> getDetails()

getTime

public Date getTime()

safePut

protected void safePut(String key,
 Object obj)