Package com.unboundid.ldap.sdk.unboundidds

Class AlertEntry

java.lang.Object
com.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.unboundidds.AlertEntry
All Implemented Interfaces:
LDIFRecord, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AlertEntry extends ReadOnlyEntry
This class provides a data structure for representing an administrative entry as exposed by the alerts backend in the Directory Server. Alert entries provide information about warnings, errors, or other significant events that could impact the availability or function of the Directory 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:

  • Field Details

  • Constructor Details

    • AlertEntry

      public AlertEntry(@NotNull Entry entry)
      Creates a new alert entry from the provided entry.
      Parameters:
      entry - The entry from which to create this alert entry.

  • Method Details

    • getAlertGeneratorClass

      @Nullable public 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

      @Nullable public 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

      @Nullable public 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

      @Nullable 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

      @Nullable public 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

      @Nullable public 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

      @Nullable public 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.