|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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
com.unboundid.ldap.sdk.unboundidds.logs.CompareResultAccessLogMessage
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CompareResultAccessLogMessage
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 the result of a compare operation processed by the Directory Server.
Constructor Summary | |
---|---|
CompareResultAccessLogMessage(LogMessage m)
Creates a new compare result access log message from the provided log message. |
|
CompareResultAccessLogMessage(java.lang.String s)
Creates a new compare result access log message from the provided message string. |
Method Summary | |
---|---|
java.lang.String |
getAdditionalInformation()
Retrieves a message with additional information about the result of the operation. |
java.lang.String |
getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation. |
java.lang.String |
getDiagnosticMessage()
Retrieves the diagnostic message for the operation. |
java.lang.String |
getIntermediateClientResult()
Retrieves the content of the intermediate client result for the operation. |
java.lang.Long |
getIntermediateResponsesReturned()
Retrieves the number of intermediate response messages returned in the course of processing the operation. |
java.lang.String |
getMatchedDN()
Retrieves the matched DN for the operation. |
AccessLogMessageType |
getMessageType()
Retrieves the message type for this access log message. |
java.util.List<java.lang.String> |
getMissingPrivileges()
Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have. |
java.util.List<java.lang.String> |
getPreAuthorizationUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned. |
java.lang.Double |
getProcessingTimeMillis()
Retrieves the length of time in milliseconds required to process the operation. |
java.lang.Double |
getQueueTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue. |
java.util.List<java.lang.String> |
getReferralURLs()
Retrieves the list of referral URLs for the operation. |
java.util.List<java.lang.String> |
getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message. |
ResultCode |
getResultCode()
Retrieves the result code for the operation. |
java.util.List<java.lang.String> |
getServersAccessed()
Retrieves a list of the additional servers that were accessed in the course of processing the operation. |
java.lang.String |
getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded. |
java.lang.Integer |
getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded. |
java.lang.String |
getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server. |
java.lang.Boolean |
getUncachedDataAccessed()
Indicates whether the server accessed any uncached data in the course of processing the operation. |
java.util.List<java.lang.String> |
getUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.CompareRequestAccessLogMessage |
---|
getAttributeName, getDN, getOperationType |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage |
---|
getIntermediateClientRequest, 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 |
---|
public CompareResultAccessLogMessage(java.lang.String s) throws LogException
s
- The string to be parsed as a compare result access log message.
LogException
- If the provided string cannot be parsed as a valid
log message.public CompareResultAccessLogMessage(LogMessage m)
m
- The log message to be parsed as a compare result access log
message.Method Detail |
---|
public ResultCode getResultCode()
getResultCode
in interface MinimalOperationResultAccessLogMessage
null
if it is not
included in the log message.public java.lang.String getDiagnosticMessage()
getDiagnosticMessage
in interface MinimalOperationResultAccessLogMessage
null
if it is
not included in the log message.public java.lang.String getAdditionalInformation()
getAdditionalInformation
in interface MinimalOperationResultAccessLogMessage
null
if it is not included in the log
message.public java.lang.String getMatchedDN()
getMatchedDN
in interface MinimalOperationResultAccessLogMessage
null
if it is not
included in the log message.public java.util.List<java.lang.String> getReferralURLs()
getReferralURLs
in interface MinimalOperationResultAccessLogMessage
public java.lang.Long getIntermediateResponsesReturned()
getIntermediateResponsesReturned
in interface OperationResultAccessLogMessage
null
if it is not included in the log message.public java.lang.Double getProcessingTimeMillis()
getProcessingTimeMillis
in interface MinimalOperationResultAccessLogMessage
null
if it is not included in the log
message.public java.lang.Double getQueueTimeMillis()
getQueueTimeMillis
in interface MinimalOperationResultAccessLogMessage
null
if it is not included in
the log message.public java.util.List<java.lang.String> getResponseControlOIDs()
getResponseControlOIDs
in interface OperationResultAccessLogMessage
public java.util.List<java.lang.String> getServersAccessed()
getServersAccessed
in interface OperationResultAccessLogMessage
public java.lang.Boolean getUncachedDataAccessed()
true
if the server was known to access uncached data in
the course of processing the operation, false
if the
server was known not to access uncached data, or null
if
it is not included in the log message (and the server likely did
not access uncached data).public java.lang.String getIntermediateClientResult()
getIntermediateClientResult
in interface OperationResultAccessLogMessage
null
if it is not included in the log message.public java.lang.String getAlternateAuthorizationDN()
null
if it is not included in the log message.public java.lang.String getTargetHost()
null
if it is not included in the log
message.public java.lang.Integer getTargetPort()
null
if it is not included in the log
message.public java.lang.String getTargetProtocol()
null
if it is not included in the log message.public java.util.List<java.lang.String> getUsedPrivileges()
public java.util.List<java.lang.String> getPreAuthorizationUsedPrivileges()
public java.util.List<java.lang.String> getMissingPrivileges()
public AccessLogMessageType getMessageType()
getMessageType
in class OperationRequestAccessLogMessage
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |