AlarmEntry (UnboundID LDAP SDK for Java 7.0.1)

java.lang.Object
- com.unboundid.ldap.sdk.Entry
- - com.unboundid.ldap.sdk.ReadOnlyEntry
  - - com.unboundid.ldap.sdk.unboundidds.AlarmEntry

All Implemented Interfaces:

LDIFRecord, java.io.Serializable
```
@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AlarmEntry
extends ReadOnlyEntry
```
This class provides a data structure for representing an administrative entry as exposed by the alarms backend in the Directory Server. Alarm entries provide information about potential ongoing or resolved conditions within the server.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AlarmEntry(Entry entry)
Creates a new alarm entry from the provided entry.

Constructors
Constructor and Description
`AlarmEntry(Entry entry)` Creates a new alarm entry from the provided entry.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlarmAdditionalText()` Retrieves the additional text for the alarm, if any.
`java.lang.String`	`getAlarmCondition()` Retrieves the condition for the alarm.
`java.lang.String`	`getAlarmDetails()` Retrieves the details message for the alarm, if any.
`java.lang.Integer`	`getAlarmEventType()` Retrieves the X.733 event type for the alarm, if available.
`java.lang.String`	`getAlarmID()` Retrieves the identifier for the alarm.
`java.util.Date`	`getAlarmLastCriticalTime()` Retrieves the time that the alarm last transitioned to a critical severity, if available.
`java.util.Date`	`getAlarmLastIndeterminateTime()` Retrieves the time that the alarm last transitioned to an indeterminate severity, if available.
`java.util.Date`	`getAlarmLastMajorTime()` Retrieves the time that the alarm last transitioned to a major severity, if available.
`java.util.Date`	`getAlarmLastMinorTime()` Retrieves the time that the alarm last transitioned to a minor severity, if available.
`java.util.Date`	`getAlarmLastNormalTime()` Retrieves the time that the alarm last transitioned to a normal severity, if available.
`java.util.Date`	`getAlarmLastWarningTime()` Retrieves the time that the alarm last transitioned to a warning severity, if available.
`java.lang.Integer`	`getAlarmProbableCause()` Retrieves the X.733 probable cause for the alarm, if available.
`java.lang.String`	`getAlarmSpecificResource()` Retrieves the specific resource for the alarm, if any.
`java.lang.String`	`getAlarmSpecificResourceType()` Retrieves the specific resource type for the alarm, if any.
`java.util.Date`	`getAlarmStartTime()` Retrieves the start time for the alarm.
`java.lang.Long`	`getAlarmTotalDurationCriticalMillis()` Retrieves the length of time in milliseconds the alarm has spent at the critical severity, if available.
`java.lang.Long`	`getAlarmTotalDurationIndeterminateMillis()` Retrieves the length of time in milliseconds the alarm has spent at the indeterminate severity, if available.
`java.lang.Long`	`getAlarmTotalDurationMajorMillis()` Retrieves the length of time in milliseconds the alarm has spent at the major severity, if available.
`java.lang.Long`	`getAlarmTotalDurationMinorMillis()` Retrieves the length of time in milliseconds the alarm has spent at the minor severity, if available.
`java.lang.Long`	`getAlarmTotalDurationNormalMillis()` Retrieves the length of time in milliseconds the alarm has spent at the normal severity, if available.
`java.lang.Long`	`getAlarmTotalDurationWarningMillis()` Retrieves the length of time in milliseconds the alarm has spent at the warning severity, if available.
`AlarmSeverity`	`getCurrentAlarmSeverity()` Retrieves the current severity for the alarm.
`AlarmSeverity`	`getPreviousAlarmSeverity()` Retrieves the previous severity for the alarm.

Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN

Methods inherited from class com.unboundid.ldap.sdk.Entry
addAttribute, applyModifications, applyModifications, applyModifyDN, applyModifyDN, diff, diff, diff, duplicate, equals, getAttribute, getAttribute, getAttributes, getAttributesWithOptions, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsDate, getAttributeValueAsDN, getAttributeValueAsInteger, getAttributeValueAsLong, getAttributeValueByteArrays, getAttributeValueBytes, getAttributeValues, getDN, getObjectClassAttribute, getObjectClassValues, getParentDN, getParentDNString, getParsedDN, getRDN, getSchema, hasAttribute, hasAttribute, hasAttribute, hasAttributeValue, hasAttributeValue, hasAttributeValue, hasAttributeValue, hashCode, hasObjectClass, intersectEntries, matchesBaseAndScope, matchesBaseAndScope, mergeEntries, removeAttributeValue, removeAttributeValue, setAttribute, toLDIF, toLDIF, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toLDIFString, toString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AlarmEntry
```
public AlarmEntry(@NotNull
                  Entry entry)
```
    Creates a new alarm entry from the provided entry.
    
    Parameters:
    
    entry - The entry to use to create this alarm entry.
- Method Detail
  - getAlarmID
```
@Nullable
public java.lang.String getAlarmID()
```
    Retrieves the identifier for the alarm.
    
    Returns:
    
    The identifier for the alarm, or null if it was not included in the alarm entry.
  - getAlarmCondition
```
@Nullable
public java.lang.String getAlarmCondition()
```
    Retrieves the condition for the alarm.
    
    Returns:
    
    The condition for the alarm, or null if it was not included in the alarm entry.
  - getCurrentAlarmSeverity
```
@Nullable
public AlarmSeverity getCurrentAlarmSeverity()
```
    Retrieves the current severity for the alarm.
    
    Returns:
    
    The current severity for the alarm, or null if it was not included in the alarm entry.
  - getPreviousAlarmSeverity
```
@Nullable
public AlarmSeverity getPreviousAlarmSeverity()
```
    Retrieves the previous severity for the alarm.
    
    Returns:
    
    The previous severity for the alarm, or null if it was not included in the alarm entry.
  - getAlarmStartTime
```
@Nullable
public java.util.Date getAlarmStartTime()
```
    Retrieves the start time for the alarm.
    
    Returns:
    
    The start time for the alarm, or null if it was not included in the alarm entry.
  - getAlarmSpecificResource
```
@Nullable
public java.lang.String getAlarmSpecificResource()
```
    Retrieves the specific resource for the alarm, if any.
    
    Returns:
    
    The specific resource for the alarm, or null if it was not included in the alarm entry.
  - getAlarmSpecificResourceType
```
@Nullable
public java.lang.String getAlarmSpecificResourceType()
```
    Retrieves the specific resource type for the alarm, if any.
    
    Returns:
    
    The specific resource type for the alarm, or null if it was not included in the alarm entry.
  - getAlarmDetails
```
@Nullable
public java.lang.String getAlarmDetails()
```
    Retrieves the details message for the alarm, if any.
    
    Returns:
    
    The details message for the alarm, or null if it was not included in the alarm entry.
  - getAlarmAdditionalText
```
@Nullable
public java.lang.String getAlarmAdditionalText()
```
    Retrieves the additional text for the alarm, if any.
    
    Returns:
    
    The additional text for the alarm, or null if it was not included in the alarm entry.
  - getAlarmLastNormalTime
```
@Nullable
public java.util.Date getAlarmLastNormalTime()
```
    Retrieves the time that the alarm last transitioned to a normal severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to a normal severity, or null if it was not included in the alarm entry.
  - getAlarmLastWarningTime
```
@Nullable
public java.util.Date getAlarmLastWarningTime()
```
    Retrieves the time that the alarm last transitioned to a warning severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to a warning severity, or null if it was not included in the alarm entry.
  - getAlarmLastMinorTime
```
@Nullable
public java.util.Date getAlarmLastMinorTime()
```
    Retrieves the time that the alarm last transitioned to a minor severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to a minor severity, or null if it was not included in the alarm entry.
  - getAlarmLastMajorTime
```
@Nullable
public java.util.Date getAlarmLastMajorTime()
```
    Retrieves the time that the alarm last transitioned to a major severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to a major severity, or null if it was not included in the alarm entry.
  - getAlarmLastCriticalTime
```
@Nullable
public java.util.Date getAlarmLastCriticalTime()
```
    Retrieves the time that the alarm last transitioned to a critical severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to a critical severity, or null if it was not included in the alarm entry.
  - getAlarmLastIndeterminateTime
```
@Nullable
public java.util.Date getAlarmLastIndeterminateTime()
```
    Retrieves the time that the alarm last transitioned to an indeterminate severity, if available.
    
    Returns:
    
    The time that the alarm last transitioned to an indeterminate severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationNormalMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationNormalMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the normal severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the normal severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationWarningMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationWarningMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the warning severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the warning severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationMinorMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationMinorMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the minor severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the minor severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationMajorMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationMajorMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the major severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the major severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationCriticalMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationCriticalMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the critical severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the critical severity, or null if it was not included in the alarm entry.
  - getAlarmTotalDurationIndeterminateMillis
```
@Nullable
public java.lang.Long getAlarmTotalDurationIndeterminateMillis()
```
    Retrieves the length of time in milliseconds the alarm has spent at the indeterminate severity, if available.
    
    Returns:
    
    The length of time in milliseconds the alarm has spent at the indeterminate severity, or null if it was not included in the alarm entry.
  - getAlarmEventType
```
@Nullable
public java.lang.Integer getAlarmEventType()
```
    Retrieves the X.733 event type for the alarm, if available.
    
    Returns:
    
    The X.733 event type for the alarm, or null if it was not included in the alarm entry.
  - getAlarmProbableCause
```
@Nullable
public java.lang.Integer getAlarmProbableCause()
```
    Retrieves the X.733 probable cause for the alarm, if available.
    
    Returns:
    
    The X.733 probable cause for the alarm, or null if it was not included in the alarm entry.

Class AlarmEntry

Constructor Summary

Method Summary

Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry

Methods inherited from class com.unboundid.ldap.sdk.Entry

Methods inherited from class java.lang.Object

Constructor Detail

AlarmEntry

Method Detail

getAlarmID

getAlarmCondition

getCurrentAlarmSeverity

getPreviousAlarmSeverity

getAlarmStartTime

getAlarmSpecificResource

getAlarmSpecificResourceType

getAlarmDetails

getAlarmAdditionalText

getAlarmLastNormalTime

getAlarmLastWarningTime

getAlarmLastMinorTime

getAlarmLastMajorTime

getAlarmLastCriticalTime

getAlarmLastIndeterminateTime

getAlarmTotalDurationNormalMillis

getAlarmTotalDurationWarningMillis

getAlarmTotalDurationMinorMillis

getAlarmTotalDurationMajorMillis

getAlarmTotalDurationCriticalMillis

getAlarmTotalDurationIndeterminateMillis

getAlarmEventType

getAlarmProbableCause