com.unboundid.ldap.sdk.unboundidds.monitors
Class GaugeMonitorEntry

java.lang.Object
  com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IndicatorGaugeMonitorEntry, NumericGaugeMonitorEntry

@NotExtensible
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class GaugeMonitorEntry
extends MonitorEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.

This class defines the base class for gauge monitor entries, which provide information common to all types of gauges. Subclasses may provide more specific information for that specific type of gauge.

See Also:

Serialized Form

Constructor Summary

GaugeMonitorEntry(Entry entry)
Creates a new gauge monitor entry from the provided entry.

Method Summary

AlarmSeverity	getCurrentSeverity() Retrieves the current severity for the gauge, if available.
java.lang.Long	getCurrentSeverityDurationMillis() Retrieves the current severity duration in milliseconds, if available.
java.lang.String	getCurrentSeverityDurationString() Retrieves the current severity duration as a human-readable string, if available.
java.util.Date	getCurrentSeverityStartTime() Retrieves the time the gauge entered the current severity, if available.
java.util.List<java.lang.String>	getErrorMessages() Retrieves the error messages for the gauge, if available.
java.lang.String	getGaugeName() Retrieves the name for the gauge, if available.
java.util.Date	getInitTime() Retrieves the time the gauge was initialized, if available.
java.lang.Long	getLastCriticalStateDurationMillis() Retrieves the duration of the last critical state in milliseconds, if available.
java.lang.String	getLastCriticalStateDurationString() Retrieves the duration of the last critical state as a human-readable string, if available.
java.util.Date	getLastCriticalStateEndTime() Retrieves the time the gauge last exited the critical state, if available.
java.util.Date	getLastCriticalStateStartTime() Retrieves the time the gauge last entered the critical state, if available.
java.lang.Long	getLastMajorStateDurationMillis() Retrieves the duration of the last major state in milliseconds, if available.
java.lang.String	getLastMajorStateDurationString() Retrieves the duration of the last major state as a human-readable string, if available.
java.util.Date	getLastMajorStateEndTime() Retrieves the time the gauge last exited the major state, if available.
java.util.Date	getLastMajorStateStartTime() Retrieves the time the gauge last entered the major state, if available.
java.lang.Long	getLastMinorStateDurationMillis() Retrieves the duration of the last minor state in milliseconds, if available.
java.lang.String	getLastMinorStateDurationString() Retrieves the duration of the last minor state as a human-readable string, if available.
java.util.Date	getLastMinorStateEndTime() Retrieves the time the gauge last exited the minor state, if available.
java.util.Date	getLastMinorStateStartTime() Retrieves the time the gauge last entered the minor state, if available.
java.lang.Long	getLastNormalStateDurationMillis() Retrieves the duration of the last normal state in milliseconds, if available.
java.lang.String	getLastNormalStateDurationString() Retrieves the duration of the last normal state as a human-readable string, if available.
java.util.Date	getLastNormalStateEndTime() Retrieves the time the gauge last exited the normal state, if available.
java.util.Date	getLastNormalStateStartTime() Retrieves the time the gauge last entered the normal state, if available.
java.lang.Long	getLastWarningStateDurationMillis() Retrieves the duration of the last warning state in milliseconds, if available.
java.lang.String	getLastWarningStateDurationString() Retrieves the duration of the last warning state as a human-readable string, if available.
java.util.Date	getLastWarningStateEndTime() Retrieves the time the gauge last exited the warning state, if available.
java.util.Date	getLastWarningStateStartTime() Retrieves the time the gauge last entered the warning state, if available.
java.util.Map<java.lang.String,MonitorAttribute>	getMonitorAttributes() Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.
java.lang.String	getMonitorDescription() Retrieves a human-readable description name for this monitor entry.
java.lang.String	getMonitorDisplayName() Retrieves a human-readable display name for this monitor entry.
AlarmSeverity	getPreviousSeverity() Retrieves the previous severity for the gauge, if available.
java.lang.String	getResource() Retrieves the resource for the gauge, if available.
java.lang.String	getResourceType() Retrieves the resource type for the gauge, if available.
java.lang.Long	getSamplesThisInterval() Retrieves the number of samples taken in the current interval, if available.
java.lang.String	getSummary() Retrieves the summary message for the gauge, if available.
java.lang.Long	getTotalCriticalStateDurationMillis() Retrieves the total length of time the gauge has been in the critical state in milliseconds, if available.
java.lang.String	getTotalCriticalStateDurationString() Retrieves the total length of time the gauge has been in the critical state as a human-readable string, if available.
java.lang.Long	getTotalMajorStateDurationMillis() Retrieves the total length of time the gauge has been in the major state in milliseconds, if available.
java.lang.String	getTotalMajorStateDurationString() Retrieves the total length of time the gauge has been in the major state as a human-readable string, if available.
java.lang.Long	getTotalMinorStateDurationMillis() Retrieves the total length of time the gauge has been in the minor state in milliseconds, if available.
java.lang.String	getTotalMinorStateDurationString() Retrieves the total length of time the gauge has been in the minor state as a human-readable string, if available.
java.lang.Long	getTotalNormalStateDurationMillis() Retrieves the total length of time the gauge has been in the normal state in milliseconds, if available.
java.lang.String	getTotalNormalStateDurationString() Retrieves the total length of time the gauge has been in the normal state as a human-readable string, if available.
java.lang.Long	getTotalWarningStateDurationMillis() Retrieves the total length of time the gauge has been in the warning state in milliseconds, if available.
java.lang.String	getTotalWarningStateDurationString() Retrieves the total length of time the gauge has been in the warning state as a human-readable string, if available.
java.util.Date	getUpdateTime() Retrieves the time the gauge was last updated, if available.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GaugeMonitorEntry

public GaugeMonitorEntry(Entry entry)

Creates a new gauge monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a gauge monitor entry. It must not be null.

Method Detail

getGaugeName

public final java.lang.String getGaugeName()

Retrieves the name for the gauge, if available.

Returns:

The name for the gauge, or null if it was not included in the monitor entry.

getResource

public final java.lang.String getResource()

Retrieves the resource for the gauge, if available.

Returns:

The resource for the gauge, or null if it was not included in the monitor entry.

getResourceType

public final java.lang.String getResourceType()

Retrieves the resource type for the gauge, if available.

Returns:

The resource type for the gauge, or null if it was not included in the monitor entry.

getCurrentSeverity

public final AlarmSeverity getCurrentSeverity()

Retrieves the current severity for the gauge, if available.

Returns:

The current severity for the gauge, or null if it was not included in the monitor entry.

getPreviousSeverity

public final AlarmSeverity getPreviousSeverity()

Retrieves the previous severity for the gauge, if available.

Returns:

The previous severity for the gauge, or null if it was not included in the monitor entry.

getSummary

public final java.lang.String getSummary()

Retrieves the summary message for the gauge, if available.

Returns:

The summary message for the gauge, or null if it was not included in the monitor entry.

getErrorMessages

public final java.util.List<java.lang.String> getErrorMessages()

Retrieves the error messages for the gauge, if available.

Returns:

The list of error messages for the gauge, or an empty list if it was not included in the monitor entry.

getInitTime

public final java.util.Date getInitTime()

Retrieves the time the gauge was initialized, if available.

Returns:

The time the gauge was initialized, or null if it was not included in the monitor entry.

getUpdateTime

public final java.util.Date getUpdateTime()

Retrieves the time the gauge was last updated, if available.

Returns:

The time the gauge was last updated, or null if it was not included in the monitor entry.

getSamplesThisInterval

public final java.lang.Long getSamplesThisInterval()

Retrieves the number of samples taken in the current interval, if available.

Returns:

The number of samples taken in the current interval, or null if it was not included in the monitor entry.

getCurrentSeverityStartTime

public final java.util.Date getCurrentSeverityStartTime()

Retrieves the time the gauge entered the current severity, if available.

Returns:

The time the gauge entered the current severity, or null if it was not included in the monitor entry.

getCurrentSeverityDurationString

public final java.lang.String getCurrentSeverityDurationString()

Retrieves the current severity duration as a human-readable string, if available.

Returns:

The current severity duration as a human-readable string, or null if it was not included in the monitor entry.

getCurrentSeverityDurationMillis

public final java.lang.Long getCurrentSeverityDurationMillis()

Retrieves the current severity duration in milliseconds, if available.

Returns:

The current severity duration in milliseconds, or null if it was not included in the monitor entry.

getLastNormalStateStartTime

public final java.util.Date getLastNormalStateStartTime()

Retrieves the time the gauge last entered the normal state, if available.

Returns:

The time the gauge last entered the normal state, or null if it was not included in the monitor entry.

getLastNormalStateEndTime

public final java.util.Date getLastNormalStateEndTime()

Retrieves the time the gauge last exited the normal state, if available.

Returns:

The time the gauge last exited the normal state, or null if it was not included in the monitor entry.

getLastNormalStateDurationString

public final java.lang.String getLastNormalStateDurationString()

Retrieves the duration of the last normal state as a human-readable string, if available.

Returns:

The duration of the last normal state as a human-readable string, or null if it was not included in the monitor entry.

getLastNormalStateDurationMillis

public final java.lang.Long getLastNormalStateDurationMillis()

Retrieves the duration of the last normal state in milliseconds, if available.

Returns:

The duration of the last normal state in milliseconds, or null if it was not included in the monitor entry.

getTotalNormalStateDurationString

public final java.lang.String getTotalNormalStateDurationString()

Retrieves the total length of time the gauge has been in the normal state as a human-readable string, if available.

Returns:

The total length of time the gauge has been in the normal state as a human-readable string, or null if it was not included in the monitor entry.

getTotalNormalStateDurationMillis

public final java.lang.Long getTotalNormalStateDurationMillis()

Retrieves the total length of time the gauge has been in the normal state in milliseconds, if available.

Returns:

The total length of time the gauge has been in the normal state in milliseconds, or null if it was not included in the monitor entry.

getLastWarningStateStartTime

public final java.util.Date getLastWarningStateStartTime()

Retrieves the time the gauge last entered the warning state, if available.

Returns:

The time the gauge last entered the warning state, or null if it was not included in the monitor entry.

getLastWarningStateEndTime

public final java.util.Date getLastWarningStateEndTime()

Retrieves the time the gauge last exited the warning state, if available.

Returns:

The time the gauge last exited the warning state, or null if it was not included in the monitor entry.

getLastWarningStateDurationString

public final java.lang.String getLastWarningStateDurationString()

Retrieves the duration of the last warning state as a human-readable string, if available.

Returns:

The duration of the last warning state as a human-readable string, or null if it was not included in the monitor entry.

getLastWarningStateDurationMillis

public final java.lang.Long getLastWarningStateDurationMillis()

Retrieves the duration of the last warning state in milliseconds, if available.

Returns:

The duration of the last warning state in milliseconds, or null if it was not included in the monitor entry.

getTotalWarningStateDurationString

public final java.lang.String getTotalWarningStateDurationString()

Retrieves the total length of time the gauge has been in the warning state as a human-readable string, if available.

Returns:

The total length of time the gauge has been in the warning state as a human-readable string, or null if it was not included in the monitor entry.

getTotalWarningStateDurationMillis

public final java.lang.Long getTotalWarningStateDurationMillis()

Retrieves the total length of time the gauge has been in the warning state in milliseconds, if available.

Returns:

The total length of time the gauge has been in the warning state in milliseconds, or null if it was not included in the monitor entry.

getLastMinorStateStartTime

public final java.util.Date getLastMinorStateStartTime()

Retrieves the time the gauge last entered the minor state, if available.

Returns:

The time the gauge last entered the minor state, or null if it was not included in the monitor entry.

getLastMinorStateEndTime

public final java.util.Date getLastMinorStateEndTime()

Retrieves the time the gauge last exited the minor state, if available.

Returns:

The time the gauge last exited the minor state, or null if it was not included in the monitor entry.

getLastMinorStateDurationString

public final java.lang.String getLastMinorStateDurationString()

Retrieves the duration of the last minor state as a human-readable string, if available.

Returns:

The duration of the last minor state as a human-readable string, or null if it was not included in the monitor entry.

getLastMinorStateDurationMillis

public final java.lang.Long getLastMinorStateDurationMillis()

Retrieves the duration of the last minor state in milliseconds, if available.

Returns:

The duration of the last minor state in milliseconds, or null if it was not included in the monitor entry.

getTotalMinorStateDurationString

public final java.lang.String getTotalMinorStateDurationString()

Retrieves the total length of time the gauge has been in the minor state as a human-readable string, if available.

Returns:

The total length of time the gauge has been in the minor state as a human-readable string, or null if it was not included in the monitor entry.

getTotalMinorStateDurationMillis

public final java.lang.Long getTotalMinorStateDurationMillis()

Retrieves the total length of time the gauge has been in the minor state in milliseconds, if available.

Returns:

The total length of time the gauge has been in the minor state in milliseconds, or null if it was not included in the monitor entry.

getLastMajorStateStartTime

public final java.util.Date getLastMajorStateStartTime()

Retrieves the time the gauge last entered the major state, if available.

Returns:

The time the gauge last entered the major state, or null if it was not included in the monitor entry.

getLastMajorStateEndTime

public final java.util.Date getLastMajorStateEndTime()

Retrieves the time the gauge last exited the major state, if available.

Returns:

The time the gauge last exited the major state, or null if it was not included in the monitor entry.

getLastMajorStateDurationString

public final java.lang.String getLastMajorStateDurationString()

Retrieves the duration of the last major state as a human-readable string, if available.

Returns:

The duration of the last major state as a human-readable string, or null if it was not included in the monitor entry.

getLastMajorStateDurationMillis

public final java.lang.Long getLastMajorStateDurationMillis()

Retrieves the duration of the last major state in milliseconds, if available.

Returns:

The duration of the last major state in milliseconds, or null if it was not included in the monitor entry.

getTotalMajorStateDurationString

public final java.lang.String getTotalMajorStateDurationString()

Retrieves the total length of time the gauge has been in the major state as a human-readable string, if available.

Returns:

The total length of time the gauge has been in the major state as a human-readable string, or null if it was not included in the monitor entry.

getTotalMajorStateDurationMillis

public final java.lang.Long getTotalMajorStateDurationMillis()

Retrieves the total length of time the gauge has been in the major state in milliseconds, if available.

Returns:

The total length of time the gauge has been in the major state in milliseconds, or null if it was not included in the monitor entry.

getLastCriticalStateStartTime

public final java.util.Date getLastCriticalStateStartTime()

Retrieves the time the gauge last entered the critical state, if available.

Returns:

The time the gauge last entered the critical state, or null if it was not included in the monitor entry.

getLastCriticalStateEndTime

public final java.util.Date getLastCriticalStateEndTime()

Retrieves the time the gauge last exited the critical state, if available.

Returns:

The time the gauge last exited the critical state, or null if it was not included in the monitor entry.

getLastCriticalStateDurationString

public final java.lang.String getLastCriticalStateDurationString()

Retrieves the duration of the last critical state as a human-readable string, if available.

Returns:

The duration of the last critical state as a human-readable string, or null if it was not included in the monitor entry.

getLastCriticalStateDurationMillis

public final java.lang.Long getLastCriticalStateDurationMillis()

Retrieves the duration of the last critical state in milliseconds, if available.

Returns:

The duration of the last critical state in milliseconds, or null if it was not included in the monitor entry.

getTotalCriticalStateDurationString

public final java.lang.String getTotalCriticalStateDurationString()

Retrieves the total length of time the gauge has been in the critical state as a human-readable string, if available.

Returns:

The total length of time the gauge has been in the critical state as a human-readable string, or null if it was not included in the monitor entry.

getTotalCriticalStateDurationMillis

public final java.lang.Long getTotalCriticalStateDurationMillis()

Retrieves the total length of time the gauge has been in the critical state in milliseconds, if available.

Returns:

The total length of time the gauge has been in the critical state in milliseconds, or null if it was not included in the monitor entry.

getMonitorDisplayName

public java.lang.String getMonitorDisplayName()

Retrieves a human-readable display name for this monitor entry.

Overrides:

getMonitorDisplayName in class MonitorEntry

Returns:

A human-readable display name for this monitor entry.

getMonitorDescription

public java.lang.String getMonitorDescription()

Retrieves a human-readable description name for this monitor entry.

Overrides:

getMonitorDescription in class MonitorEntry

Returns:

A human-readable description name for this monitor entry.

getMonitorAttributes

public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()

Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.

Overrides:

getMonitorAttributes in class MonitorEntry

Returns:

The set of parsed monitor attributes for this monitor entry.