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

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.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by com.unboundid.ldap.sdk.unboundidds.logs.CompareRequestAccessLogMessage
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CompareForwardAccessLogMessage, CompareForwardFailedAccessLogMessage, CompareResultAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class CompareRequestAccessLogMessage
extends OperationRequestAccessLogMessage

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 compare request received from a client.

See Also:
Serialized Form

Constructor Summary
CompareRequestAccessLogMessage(LogMessage m)
          Creates a new compare request access log message from the provided log message.
CompareRequestAccessLogMessage(java.lang.String s)
          Creates a new compare request access log message from the provided message string.
 
Method Summary
 java.lang.String getAttributeName()
          Retrieves the name of the attribute for which the compare is to be performed.
 java.lang.String getDN()
          Retrieves the DN of the entry for which the compare is to be performed.
 AccessLogOperationType getOperationType()
          Retrieves the operation type for the associated operation.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getMessageType, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin
 
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

CompareRequestAccessLogMessage

public CompareRequestAccessLogMessage(java.lang.String s)
                               throws LogException
Creates a new compare request access log message from the provided message string.

Parameters:
s - The string to be parsed as a compare request access log message.
Throws:
LogException - If the provided string cannot be parsed as a valid log message.

CompareRequestAccessLogMessage

public CompareRequestAccessLogMessage(LogMessage m)
Creates a new compare request access log message from the provided log message.

Parameters:
m - The log message to be parsed as a compare request access log message.
Method Detail

getDN

public final java.lang.String getDN()
Retrieves the DN of the entry for which the compare is to be performed.

Returns:
The DN of the entry for which the compare is to be performed, or null if it is not included in the log message.

getAttributeName

public final java.lang.String getAttributeName()
Retrieves the name of the attribute for which the compare is to be performed.

Returns:
The name of the attribute for which the compare is to be performed, or null if it is not included in the log message.

getOperationType

public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.

Specified by:
getOperationType in class OperationAccessLogMessage
Returns:
The operation type for this access log message.