com.unboundid.ldap.sdk.unboundidds
Class AlertEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.Entry
      extended by com.unboundid.ldap.sdk.ReadOnlyEntry
          extended by com.unboundid.ldap.sdk.unboundidds.AlertEntry
All Implemented Interfaces:
LDIFRecord, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AlertEntry
extends ReadOnlyEntry

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 provides a data structure for representing an administrative entry as exposed by the alerts backend in the UnboundID Directory Server. Alert entries provide information about warnings, errors, or other significant events that could impact the availability or function of the UnboundID Directory Server.

See Also:
Serialized Form

Field Summary
static java.lang.String ATTR_ALERT_GENERATOR
          The name of the attribute that contains the fully-qualified name of the server class that generated the alert notification.
static java.lang.String ATTR_ALERT_ID
          The name of the attribute that contains the unique ID assigned to the alert notification.
static java.lang.String ATTR_ALERT_MESSAGE
          The name of the attribute that contains a message with additional information about the alert notification.
static java.lang.String ATTR_ALERT_SEVERITY
          The name of the attribute that contains the severity of the alert notification.
static java.lang.String ATTR_ALERT_TIME
          The name of the attribute that contains the time that the alert notification was generated.
static java.lang.String ATTR_ALERT_TYPE
          The name of the attribute that contains the name of the alert type.
static java.lang.String ATTR_ALERT_TYPE_OID
          The name of the attribute that contains the OID assigned to the alert type.
static java.lang.String OC_ALERT
          The name of the structural object class that will be used for entries containing information about administrative alerts.
 
Constructor Summary
AlertEntry(Entry entry)
          Creates a new alert entry from the provided entry.
 
Method Summary
 java.lang.String getAlertGeneratorClass()
          Retrieves the fully-qualified name of the class that generated the alert notification.
 java.lang.String getAlertID()
          Retrieves the unique identifier for the alert notification.
 java.lang.String getAlertMessage()
          Retrieves the message for the alert notification.
 AlertSeverity getAlertSeverity()
          Retrieves the severity for the alert notification.
 java.util.Date getAlertTime()
          Retrieves the time that the alert notification was generated.
 java.lang.String getAlertType()
          Retrieves the name of the alert type for the alert notification.
 java.lang.String getAlertTypeOID()
          Retrieves the OID of the alert type for the alert notification.
 
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, 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
 

Field Detail

OC_ALERT

public static final java.lang.String OC_ALERT
The name of the structural object class that will be used for entries containing information about administrative alerts.

See Also:
Constant Field Values

ATTR_ALERT_GENERATOR

public static final java.lang.String ATTR_ALERT_GENERATOR
The name of the attribute that contains the fully-qualified name of the server class that generated the alert notification.

See Also:
Constant Field Values

ATTR_ALERT_ID

public static final java.lang.String ATTR_ALERT_ID
The name of the attribute that contains the unique ID assigned to the alert notification.

See Also:
Constant Field Values

ATTR_ALERT_MESSAGE

public static final java.lang.String ATTR_ALERT_MESSAGE
The name of the attribute that contains a message with additional information about the alert notification.

See Also:
Constant Field Values

ATTR_ALERT_SEVERITY

public static final java.lang.String ATTR_ALERT_SEVERITY
The name of the attribute that contains the severity of the alert notification.

See Also:
Constant Field Values

ATTR_ALERT_TIME

public static final java.lang.String ATTR_ALERT_TIME
The name of the attribute that contains the time that the alert notification was generated.

See Also:
Constant Field Values

ATTR_ALERT_TYPE

public static final java.lang.String ATTR_ALERT_TYPE
The name of the attribute that contains the name of the alert type.

See Also:
Constant Field Values

ATTR_ALERT_TYPE_OID

public static final java.lang.String ATTR_ALERT_TYPE_OID
The name of the attribute that contains the OID assigned to the alert type.

See Also:
Constant Field Values
Constructor Detail

AlertEntry

public AlertEntry(Entry entry)
Creates a new alert entry from the provided entry.

Parameters:
entry - The entry from which to create this alert entry.
Method Detail

getAlertGeneratorClass

public java.lang.String getAlertGeneratorClass()
Retrieves the fully-qualified name of the class that generated the alert notification.

Returns:
The fully-qualified name of the class that generated the alert notification, or null if it was not included in the alert entry.

getAlertID

public java.lang.String getAlertID()
Retrieves the unique identifier for the alert notification.

Returns:
The unique identifier for the alert notification, or null if it was not included in the alert entry.

getAlertMessage

public java.lang.String getAlertMessage()
Retrieves the message for the alert notification.

Returns:
The message for the alert notification, or null if it was not included in the alert entry.

getAlertSeverity

public AlertSeverity getAlertSeverity()
Retrieves the severity for the alert notification.

Returns:
The severity for the alert notification, or null if it was not included in the alert entry, or if it included an unknown severity.

getAlertTime

public java.util.Date getAlertTime()
Retrieves the time that the alert notification was generated.

Returns:
The time that the alert notification was generated, or null if it was not included in the alert entry or if the alert time value could not be parsed.

getAlertType

public java.lang.String getAlertType()
Retrieves the name of the alert type for the alert notification.

Returns:
The name of the alert type for the alert notification, or null if it was not included in the alert entry.

getAlertTypeOID

public java.lang.String getAlertTypeOID()
Retrieves the OID of the alert type for the alert notification.

Returns:
The OID of the alert type for the alert notification, or null if it was not included in the alert entry.