org.codice.ddf.notifications.store

Class PersistentNotification

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,String>

org.codice.ddf.notifications.store.PersistentNotification

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

public class PersistentNotification
extends HashMap<String,String>

Serializable Notification that is persisted to disk by @FileSystemPersistenceProvider and includes the unique ID generated as the cache key for the notification.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTIFICATION_KEY_APPLICATION
static String	NOTIFICATION_KEY_MESSAGE
static String	NOTIFICATION_KEY_TIMESTAMP
static String	NOTIFICATION_KEY_TITLE
static String	NOTIFICATION_KEY_USER_ID
static String	NOTIFICATION_KEY_UUID

Constructor Summary

Constructors

Constructor and Description
PersistentNotification(String application, String title, String message, Long timestamp) Constructs a Notification with the specified application name, title message, and timestamp.
PersistentNotification(String application, String title, String message, Long timestamp, String userId) Constructs a Notification with the specified application name, title message, timestamp, and user ID.
PersistentNotification(String application, String title, String message, String timestamp) Constructs a Notification with the specified application name, title message, and timestamp.
PersistentNotification(String application, String title, String message, String timestamp, String userId) Constructs a Notification with the specified application name, title message, timestamp, and user ID.

Method Summary

Modifier and Type	Method and Description
String	getApplication() Returns the name of the application that triggered the generation of the Notification
String	getId() Returns the unique ID of the Notification
String	getMessage() Returns the name of the message associated with the Notification
Long	getTimestampLong() Returns a long depicting the time at which the event that triggered this Notification occurred.
String	getTimestampString() Returns a String depicting the time at which the event that triggered this Notification occurred.
String	getTitle() Returns the name of the title of the Notification
String	getUserId() Returns the id of the user to whom this Notification is addressed.
void	setApplication(String application) Overwrites the name of the application that triggered the generation of the Notification
void	setId(String id) Overwrites the unique ID of the Notification
void	setMessage(String message) Overwrites the message associated with the Notification
void	setTimestamp(Long timestamp) Overwrites the timestamp that depicts the time at which the event that triggered the Notification occurred.
void	setTimestamp(String timestampString) Overwrites the timestamp that depicts the time at which the event that triggered the Notification occurred.
void	setTitle(String title) Overwrites the title of the Notification
void	setUserId(String userId) Overwrites the id of the user to whom the Notification is addressed.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

NOTIFICATION_KEY_UUID

public static final String NOTIFICATION_KEY_UUID

See Also:

Constant Field Values

NOTIFICATION_KEY_APPLICATION

public static final String NOTIFICATION_KEY_APPLICATION

See Also:

Constant Field Values

NOTIFICATION_KEY_MESSAGE

public static final String NOTIFICATION_KEY_MESSAGE

See Also:

Constant Field Values

NOTIFICATION_KEY_TIMESTAMP

public static final String NOTIFICATION_KEY_TIMESTAMP

See Also:

Constant Field Values

NOTIFICATION_KEY_TITLE

public static final String NOTIFICATION_KEY_TITLE

See Also:

Constant Field Values

NOTIFICATION_KEY_USER_ID

public static final String NOTIFICATION_KEY_USER_ID

See Also:

Constant Field Values

Constructor Detail

PersistentNotification

public PersistentNotification(String application,
                              String title,
                              String message,
                              Long timestamp)

Constructs a Notification with the specified application name, title message, and timestamp.

Parameters:

application - The name of the application that triggered the generation of this Notification

title - The title of this Notification

message - The message associated with this Notification

timestamp - A long representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event triggering this Notification was generated.

PersistentNotification

public PersistentNotification(String application,
                              String title,
                              String message,
                              String timestamp)

Constructs a Notification with the specified application name, title message, and timestamp.

Parameters:

application - The name of the application that triggered the generation of this Notification

title - The title of this Notification

message - The message associated with this Notification

timestamp - A String representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event triggering this Notification was generated.

PersistentNotification

public PersistentNotification(String application,
                              String title,
                              String message,
                              Long timestamp,
                              String userId)

Constructs a Notification with the specified application name, title message, timestamp, and user ID.

Parameters:

application - The name of the application that triggered the generation of this Notification

title - The title of this Notification

message - The message associated with this Notification

timestamp - A long representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event triggering this Notification was generated.

userId - The id of the user to which this Notification should be sent.

PersistentNotification

public PersistentNotification(String application,
                              String title,
                              String message,
                              String timestamp,
                              String userId)

Constructs a Notification with the specified application name, title message, timestamp, and user ID.

Parameters:

application - The name of the application that triggered the generation of this Notification

title - The title of this Notification

message - The message associated with this Notification

timestamp - A String representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event triggering this Notification was generated.

userId - The id of the user to which this Notification should be sent.

Method Detail

getId

public String getId()

Returns the unique ID of the Notification

Returns:

The id of the Notification

setId

public void setId(String id)

Overwrites the unique ID of the Notification

Parameters:

id - The new unique ID of the Notification

getApplication

public String getApplication()

Returns the name of the application that triggered the generation of the Notification

Returns:

The name of the application that triggered the generation of the Notification

setApplication

public void setApplication(String application)

Overwrites the name of the application that triggered the generation of the Notification

Parameters:

application - The new name of the application that triggered the generation of the Notification

getTitle

public String getTitle()

Returns the name of the title of the Notification

Returns:

The title of the Notification

setTitle

public void setTitle(String title)

Overwrites the title of the Notification

Parameters:

title - The new title of the Notification

getMessage

public String getMessage()

Returns the name of the message associated with the Notification

Returns:

The message associated with the Notification

setMessage

public void setMessage(String message)

Overwrites the message associated with the Notification

Parameters:

message - The new message associated with the Notification

getTimestampString

public String getTimestampString()

Returns a String depicting the time at which the event that triggered this Notification occurred.

Returns:

A String representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event that triggered this Notification occurred.

getTimestampLong

public Long getTimestampLong()

Returns a long depicting the time at which the event that triggered this Notification occurred.

Returns:

A long representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event that triggered this Notification occurred.

setTimestamp

public void setTimestamp(String timestampString)

Overwrites the timestamp that depicts the time at which the event that triggered the Notification occurred.

Parameters:

timestampString - A String representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event that triggered this Notification occurred.

setTimestamp

public void setTimestamp(Long timestamp)

Overwrites the timestamp that depicts the time at which the event that triggered the Notification occurred.

Parameters:

timestamp - A long representing the number of milliseconds between January 1, 1970, 00:00:00 GMT and the point at which the event that triggered this Notification occurred.

getUserId

public String getUserId()

Returns the id of the user to whom this Notification is addressed.

Returns:

The id of the user to whom this Notification is addressed.

setUserId

public void setUserId(String userId)

Overwrites the id of the user to whom the Notification is addressed.

Parameters:

userId - The new userId to whom the Notification should be addressed.