com.unboundid.ldap.sdk.unboundidds.logs.v2

Interface DisconnectAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, java.io.Serializable

All Known Implementing Classes:

JSONDisconnectAccessLogMessage, TextFormattedDisconnectAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface DisconnectAccessLogMessage
extends AccessLogMessage

This class provides a data structure that holds information about a disconnect access log message.

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.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisconnectMessage() Retrieves a message with additional information about the disconnect.
java.lang.String	getDisconnectReason() Retrieves the disconnect reason for the log message.
java.lang.String	getRequesterIPAddress() Retrieves the IP address of the client that requested the operation.

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Method Detail

getDisconnectReason

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

getDisconnectMessage

@Nullable
java.lang.String getDisconnectMessage()

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.

getRequesterIPAddress

@Nullable
java.lang.String getRequesterIPAddress()

Retrieves the IP address of the client that requested the operation.

Returns:

The IP address of the client that requested the operation, or null if it is not included in the log message.