Class DisconnectAccessLogMessage

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class DisconnectAccessLogMessage
    extends AccessLogMessage
    This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a connection that has been closed.
    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 Detail

      • DisconnectAccessLogMessage

        public DisconnectAccessLogMessage​(@NotNull
                                          java.lang.String s)
                                   throws LogException
        Creates a new disconnect access log message from the provided message string.
        Parameters:
        s - The string to be parsed as a disconnect access log message.
        Throws:
        LogException - If the provided string cannot be parsed as a valid log message.
      • DisconnectAccessLogMessage

        public DisconnectAccessLogMessage​(@NotNull
                                          LogMessage m)
        Creates a new disconnect access log message from the provided log message.
        Parameters:
        m - The log message to be parsed as a disconnect access log message.
    • Method Detail

      • getDisconnectReason

        @Nullable
        public java.lang.String getDisconnectReason()
        Retrieves the disconnect reason for the log message.
        Returns:
        The disconnect reason for the log message, or null if it is not included in the log message.
      • getMessage

        @Nullable
        public java.lang.String getMessage()
        Retrieves a message with additional information about the disconnect.
        Returns:
        A message with additional information about the disconnect, or null if it is not included in the log message.