com.nt.udc.log

Class StatusMessage

java.lang.Object

com.nt.udc.log.StatusMessage

All Implemented Interfaces:

java.io.Serializable

public class StatusMessage
extends java.lang.Object
implements java.io.Serializable

This class defines the structure of the status message object that is used by the Log Server to communicate with the Log GUI.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CRITICAL
static java.lang.String	CRITICAL_TEXT
static int	DEBUG
static java.lang.String	DEBUG_TEXT
static int	ERROR
static int	GOOD
static java.lang.String	GOOD_TEXT
static int	HEARTBEAT
static java.lang.String	HEARTBEAT_TEXT
static int	MAJOR
static java.lang.String	MAJOR_TEXT
static int	MINOR
static java.lang.String	MINOR_TEXT
static int	WARNING
static java.lang.String	WARNING_TEXT

Constructor Summary

Constructors

Constructor and Description
StatusMessage()
StatusMessage(long dateTime, java.lang.String appid, java.lang.String entityid, java.lang.String functdesc, int stat, java.lang.String txt) Constructor for the class.
StatusMessage(long dateTime, java.lang.String snmpComponentName, java.lang.String nodeId, java.lang.String category, int severity, java.lang.String alarmText, java.lang.String addText) Message object used by the Logger class.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareSeverityTo(StatusMessage sm) Compares severity of this status message with that of the parameter status message.
java.lang.String	getAdditionalText()
java.lang.String	getAppId()
long	getDateTime()
java.lang.String	getEntityId()
java.lang.String	getFormattedDateTime() The getFormattedDateTime() method converts long time stored in a StatusMessage object to a readable string.
java.lang.String	getFunctDesc()
int	getNotificationId()
int	getStatus()
java.lang.String	getStatusAsString()
java.lang.String	getText()
boolean	isRunning()
void	setAdditionalText(java.lang.String txt)
void	setAppId(java.lang.String Id)
void	setDateTime(long dateTime)
void	setEntityId(java.lang.String Id)
void	setFunctDesc(java.lang.String fd)
void	setNotificationId(int n)
void	setRunning(boolean flag)
void	setStatus(int stat)
void	setText(java.lang.String txt)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GOOD

public static final int GOOD

See Also:

Constant Field Values

WARNING

public static final int WARNING

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

ERROR

public static final int ERROR

See Also:

Constant Field Values

CRITICAL

public static final int CRITICAL

See Also:

Constant Field Values

HEARTBEAT

public static final int HEARTBEAT

See Also:

Constant Field Values

DEBUG

public static final int DEBUG

See Also:

Constant Field Values

GOOD_TEXT

public static final java.lang.String GOOD_TEXT

See Also:

Constant Field Values

WARNING_TEXT

public static final java.lang.String WARNING_TEXT

See Also:

Constant Field Values

MINOR_TEXT

public static final java.lang.String MINOR_TEXT

See Also:

Constant Field Values

MAJOR_TEXT

public static final java.lang.String MAJOR_TEXT

See Also:

Constant Field Values

CRITICAL_TEXT

public static final java.lang.String CRITICAL_TEXT

See Also:

Constant Field Values

HEARTBEAT_TEXT

public static final java.lang.String HEARTBEAT_TEXT

See Also:

Constant Field Values

DEBUG_TEXT

public static final java.lang.String DEBUG_TEXT

See Also:

Constant Field Values

Constructor Detail

StatusMessage

public StatusMessage(long dateTime,
             java.lang.String appid,
             java.lang.String entityid,
             java.lang.String functdesc,
             int stat,
             java.lang.String txt)

Constructor for the class. Message object used by the Logger class. Messages can be constructed with a status level.

Parameters:

dateTime - When the StatusMessage as generated.

appid - String id for application associated with message.

entityid - Id of item with this status (ie. node id)

functdesc - Internal code used to clear bad statuses.

stat - Status level of message.

txt - Text of status message.

StatusMessage

public StatusMessage(long dateTime,
             java.lang.String snmpComponentName,
             java.lang.String nodeId,
             java.lang.String category,
             int severity,
             java.lang.String alarmText,
             java.lang.String addText)

Message object used by the Logger class. Messages are constructed with a status level.

Parameters:

dateTime - When the StatusMessage as generated.

snmpComponentName - String id for application associated with message.

nodeId - Id of item with this status (ie. node id)

category - Category for this type of status condition.

severity - one of warning, minor, major, critical, or clear/good

alarmText - Text describing the fault condition. This attribute should contain no variable content (i.e. time, address, nodeId) so that it can be used as an index key.

addText - Additional text describing the status condition. This field may contain detailed, variable information.

StatusMessage

public StatusMessage()

Method Detail

setDateTime

public void setDateTime(long dateTime)

getDateTime

public long getDateTime()

getFormattedDateTime

public java.lang.String getFormattedDateTime()

The getFormattedDateTime() method converts long time stored in a StatusMessage object to a readable string.

setAppId

public void setAppId(java.lang.String Id)

getAppId

public java.lang.String getAppId()

setEntityId

public void setEntityId(java.lang.String Id)

getEntityId

public java.lang.String getEntityId()

setFunctDesc

public void setFunctDesc(java.lang.String fd)

getFunctDesc

public java.lang.String getFunctDesc()

setStatus

public void setStatus(int stat)

getStatus

public int getStatus()

getStatusAsString

public java.lang.String getStatusAsString()

getNotificationId

public int getNotificationId()

setNotificationId

public void setNotificationId(int n)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String txt)

getAdditionalText

public java.lang.String getAdditionalText()

setAdditionalText

public void setAdditionalText(java.lang.String txt)

isRunning

public boolean isRunning()

setRunning

public void setRunning(boolean flag)

compareSeverityTo

public int compareSeverityTo(StatusMessage sm)

Compares severity of this status message with that of the parameter status message.

Parameters:

sm - StatusMessage we are comparing this message to.

Returns:

if "this" is less severe than "sm", return -1 if "this" is as severe as "sm", return 0 if "this" is more severe than "sm", return 1 Treat "GOOD" and "HEARTBEAT" as equal in severity.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object