com.tailf.notif

Class ProgressNotification

Object

com.tailf.notif.Notification

com.tailf.notif.ProgressNotification

Direct Known Subclasses:

CommitProgressNotification

public class ProgressNotification
extends Notification

Data structure for progress notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressNotification.ProgressEventType Progress event type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABASE_CANDIDATE Deprecated. Use Conf.DB_CANDIDATE instead.
static int	DATABASE_NO_DB Deprecated. Use Conf.DB_NONE instead.
static int	DATABASE_RUNNING Deprecated. Use Conf.DB_RUNNING instead.
static int	DATABASE_STARTUP Deprecated. Use Conf.DB_STARTUP instead.

Constructor Summary

Constructors

Constructor and Description
ProgressNotification(NotificationType type, ProgressNotification.ProgressEventType progressEventType, Long timestamp, Long duration, int usid, int tid, int datastore, String context, String trace_id, String subsystem, String phase, String message, String annotation)
ProgressNotification(NotificationType type, ProgressNotification.ProgressEventType progressEventType, Long timestamp, Long duration, int usid, int tid, int datastore, String context, String trace_id, String subsystem, String phase, String message, String annotation, String service, String servicePhase, Long commitQueueId, String node, String device, String devicePhase, String pkg)

Method Summary

Modifier and Type	Method and Description
String	getAnnotation() Metadata about the event, indicating error, explains latency or show result etc.
Long	getCommitQueueId() Commit queue item id.
String	getContext() The context is either one of netconf, cli, webui, snmp, rest, system or it can be any other context string defined through the use of MAAPI.
int	getDatastore() Name of the datastore for which the transaction is started: Conf.DB_NONE Conf.DB_CANDIDATE Conf.DB_RUNNING Conf.DB_STARTUP Conf.DB_OPERATIONAL Conf.DB_PRE_COMMIT_RUNNING Conf.DB_INTENDED
String	getDatastoreStr() Name, as string, of the datastore for which the transaction is started.
int	getDBName() Deprecated. Use ProgressNotification.getDatastore() instead.
String	getDevice() Device name.
String	getDevicePhase() Device communication phase.
Long	getDuration() Duration of the event in microseconds.
String	getMessage() Progress event messeage.
String	getNode() Remote node name.
String	getPackage() The package from which the event originates.
String	getPhase() Transaction phase.
ProgressNotification.ProgressEventType	getProgressEventType() Progress event type.
String	getService() The invoked service instance.
String	getServicePhase() Callback phase of the invoked service.
int	getSessionId() User session id.
String	getSubsystem() Subsystem name.
Long	getTimestamp() Timestamp in microseconds since Epoch.
String	getTraceID() Per request unique trace id, included in headers and entries for relevant logs.
int	getTransaction() Deprecated. Use ProgressNotification.getTransactionId() instead.
int	getTransactionId() Transaction id.
int	getUserId() Deprecated. Use ProgressNotification.getSessionId() instead.
String	toString()

Methods inherited from class com.tailf.notif.Notification

getNotificationType

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATABASE_NO_DB

@Deprecated
public static final int DATABASE_NO_DB

Deprecated. Use Conf.DB_NONE instead.

See Also:

Constant Field Values

DATABASE_CANDIDATE

@Deprecated
public static final int DATABASE_CANDIDATE

Deprecated. Use Conf.DB_CANDIDATE instead.

See Also:

Constant Field Values

DATABASE_RUNNING

@Deprecated
public static final int DATABASE_RUNNING

Deprecated. Use Conf.DB_RUNNING instead.

See Also:

Constant Field Values

DATABASE_STARTUP

@Deprecated
public static final int DATABASE_STARTUP

Deprecated. Use Conf.DB_STARTUP instead.

See Also:

Constant Field Values

Constructor Detail

ProgressNotification

public ProgressNotification(NotificationType type,
                            ProgressNotification.ProgressEventType progressEventType,
                            Long timestamp,
                            Long duration,
                            int usid,
                            int tid,
                            int datastore,
                            String context,
                            String trace_id,
                            String subsystem,
                            String phase,
                            String message,
                            String annotation)

ProgressNotification

public ProgressNotification(NotificationType type,
                            ProgressNotification.ProgressEventType progressEventType,
                            Long timestamp,
                            Long duration,
                            int usid,
                            int tid,
                            int datastore,
                            String context,
                            String trace_id,
                            String subsystem,
                            String phase,
                            String message,
                            String annotation,
                            String service,
                            String servicePhase,
                            Long commitQueueId,
                            String node,
                            String device,
                            String devicePhase,
                            String pkg)

Method Detail

toString

public String toString()

Overrides:

toString in class Notification

getDBName

@Deprecated
public int getDBName()

Deprecated. Use ProgressNotification.getDatastore() instead.

getUserId

@Deprecated
public int getUserId()

Deprecated. Use ProgressNotification.getSessionId() instead.

getTransaction

@Deprecated
public int getTransaction()

Deprecated. Use ProgressNotification.getTransactionId() instead.

getProgressEventType

public ProgressNotification.ProgressEventType getProgressEventType()

Progress event type.

getTimestamp

public Long getTimestamp()

Timestamp in microseconds since Epoch. Depending on the progress event type, this timestamp indicates the start of the event, the end of the event, or just when the event occured.

getDuration

public Long getDuration()

Duration of the event in microseconds. Generated at the end of an event. The timestamp subtracted with the duration equals the start of the event.

getSessionId

public int getSessionId()

User session id.

getTransactionId

public int getTransactionId()

Transaction id.

getDatastore

public int getDatastore()

Name of the datastore for which the transaction is started:

• Conf.DB_NONE
• Conf.DB_CANDIDATE
• Conf.DB_RUNNING
• Conf.DB_STARTUP
• Conf.DB_OPERATIONAL
• Conf.DB_PRE_COMMIT_RUNNING
• Conf.DB_INTENDED

getDatastoreStr

public String getDatastoreStr()

Name, as string, of the datastore for which the transaction is started.

getContext

public String getContext()

The context is either one of netconf, cli, webui, snmp, rest, system or it can be any other context string defined through the use of MAAPI.

getTraceID

public String getTraceID()

Per request unique trace id, included in headers and entries for relevant logs.

getSubsystem

public String getSubsystem()

Subsystem name.

getPhase

public String getPhase()

Transaction phase.

getMessage

public String getMessage()

Progress event messeage.

getAnnotation

public String getAnnotation()

Metadata about the event, indicating error, explains latency or show result etc.

getService

public String getService()

The invoked service instance. NCS specific function

getServicePhase

public String getServicePhase()

Callback phase of the invoked service. NCS specific function

getCommitQueueId

public Long getCommitQueueId()

Commit queue item id. NCS specific function

getNode

public String getNode()

Remote node name. NCS specific function

getDevice

public String getDevice()

Device name. NCS specific function

getDevicePhase

public String getDevicePhase()

Device communication phase. NCS specific function

getPackage

public String getPackage()

The package from which the event originates. NCS specific function