com.unboundid.ldap.sdk.unboundidds.logs
Class DisconnectAccessLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.DisconnectAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DisconnectAccessLogMessage
extends AccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

See Also:
Serialized Form

Constructor Summary
DisconnectAccessLogMessage(LogMessage m)
          Creates a new disconnect access log message from the provided log message.
DisconnectAccessLogMessage(java.lang.String s)
          Creates a new disconnect access log message from the provided message string.
 
Method Summary
 java.lang.String getDisconnectReason()
          Retrieves the disconnect reason for the log message.
 java.lang.String getMessage()
          Retrieves a message with additional information about the disconnect.
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DisconnectAccessLogMessage

public DisconnectAccessLogMessage(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(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

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

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.

getMessageType

public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.

Specified by:
getMessageType in class AccessLogMessage
Returns:
The message type for this access log message.