Interface MinimalOperationResultAccessLogMessage
-
- All Known Subinterfaces:
OperationResultAccessLogMessage
- All Known Implementing Classes:
AbandonResultAccessLogMessage
,AddAssuranceCompletedAccessLogMessage
,AddResultAccessLogMessage
,BindResultAccessLogMessage
,CompareResultAccessLogMessage
,DeleteAssuranceCompletedAccessLogMessage
,DeleteResultAccessLogMessage
,ExtendedResultAccessLogMessage
,ModifyAssuranceCompletedAccessLogMessage
,ModifyDNAssuranceCompletedAccessLogMessage
,ModifyDNResultAccessLogMessage
,ModifyResultAccessLogMessage
,SearchResultAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface MinimalOperationResultAccessLogMessage
This interface defines a number of methods common to all types of operation result access log messages.
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAdditionalInformation()
Retrieves a message with additional information about the result of the operation.java.lang.String
getDiagnosticMessage()
Retrieves the diagnostic message for the operation.java.lang.String
getMatchedDN()
Retrieves the matched DN for the operation.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.ResultCode
getResultCode()
Retrieves the result code for the operation.
-
-
-
Method Detail
-
getResultCode
@Nullable ResultCode getResultCode()
Retrieves the result code for the operation.- Returns:
- The result code for the operation, or
null
if it is not included in the log message.
-
getDiagnosticMessage
@Nullable java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for the operation.- Returns:
- The diagnostic message for the operation, or
null
if it is not included in the log message.
-
getAdditionalInformation
@Nullable java.lang.String getAdditionalInformation()
Retrieves a message with additional information about the result of the operation.- Returns:
- A message with additional information about the result of the
operation, or
null
if it is not included in the log message.
-
getMatchedDN
@Nullable java.lang.String getMatchedDN()
Retrieves the matched DN for the operation.- Returns:
- The matched DN for the operation, or
null
if it is not included in the log message.
-
getReferralURLs
@NotNull java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for the operation.- Returns:
- The list of referral URLs for the operation, or an empty list if it is not included in the log message.
-
getProcessingTimeMillis
@Nullable java.lang.Double getProcessingTimeMillis()
Retrieves the length of time in milliseconds required to process the operation.- Returns:
- The length of time in milliseconds required to process the
operation, or
null
if it is not included in the log message.
-
getQueueTimeMillis
@Nullable java.lang.Double getQueueTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue.- Returns:
- The length of time in milliseconds the operation was required to
wait on the work queue, or
null
if it is not included in the log message.
-
-