Class CompareRequestAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
-
- 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
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.
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 Summary
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, getTriggeredByConnectionID, getTriggeredByOperationID
-
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
-
-
-
-
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 classOperationAccessLogMessage
- Returns:
- The operation type for this access log message.
-
-