Class AlertEntry

  • All Implemented Interfaces:
    LDIFRecord, java.io.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:
    Serialized Form
    • 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_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
    • 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.