Class TextFormattedDisconnectAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedDisconnectAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,DisconnectAccessLogMessage
,LogMessage
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TextFormattedDisconnectAccessLogMessage extends TextFormattedAccessLogMessage implements DisconnectAccessLogMessage
This class provides a data structure that holds information about a text-formatted 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.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
NO_FIELD_NAME
-
-
Constructor Summary
Constructors Constructor Description TextFormattedDisconnectAccessLogMessage(java.lang.String logMessageString)
Creates a new text-formatted disconnect access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.AccessLogMessageType
getMessageType()
Retrieves the message type for this access log message.java.lang.String
getRequesterIPAddress()
Retrieves the IP address of the client that requested the operation.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, 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
-
-
-
-
Constructor Detail
-
TextFormattedDisconnectAccessLogMessage
public TextFormattedDisconnectAccessLogMessage(@NotNull java.lang.String logMessageString) throws LogException
Creates a new text-formatted disconnect access log message from the provided message string.- Parameters:
logMessageString
- The string representation of this log message. It must not benull
.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
-
Method Detail
-
getMessageType
@NotNull public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Specified by:
getMessageType
in interfaceAccessLogMessage
- Returns:
- The message type for this access log message.
-
getDisconnectReason
@Nullable public java.lang.String getDisconnectReason()
Retrieves the disconnect reason for the log message.- Specified by:
getDisconnectReason
in interfaceDisconnectAccessLogMessage
- Returns:
- The disconnect reason for the log message, or
null
if it is not included in the log message.
-
getDisconnectMessage
@Nullable public java.lang.String getDisconnectMessage()
Retrieves a message with additional information about the disconnect.- Specified by:
getDisconnectMessage
in interfaceDisconnectAccessLogMessage
- Returns:
- A message with additional information about the disconnect, or
null
if it is not included in the log message.
-
getRequesterIPAddress
@Nullable public java.lang.String getRequesterIPAddress()
Retrieves the IP address of the client that requested the operation.- Specified by:
getRequesterIPAddress
in interfaceDisconnectAccessLogMessage
- Returns:
- The IP address of the client that requested the operation, or
null
if it is not included in the log message.
-
-