Class TextFormattedAddResultAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAddRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAddResultAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,AddForwardAccessLogMessage
,AddRequestAccessLogMessage
,AddResultAccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationRequestAccessLogMessage
,OperationResultAccessLogMessage
,java.io.Serializable
- Direct Known Subclasses:
TextFormattedAddAssuranceCompletedAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class TextFormattedAddResultAccessLogMessage extends TextFormattedAddRequestAccessLogMessage implements AddResultAccessLogMessage
This class provides a data structure that holds information about a text-formatted add result access log message.
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
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
NO_FIELD_NAME
-
-
Constructor Summary
Constructors Constructor Description TextFormattedAddResultAccessLogMessage(java.lang.String logMessageString)
Creates a new text-formatted add result access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete 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
getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation.AssuredReplicationLocalLevel
getAssuredReplicationLocalLevel()
Retrieves the local level that will be used for assured replication processing, if available.AssuredReplicationRemoteLevel
getAssuredReplicationRemoteLevel()
Retrieves the remote level that will be used for assured replication processing, if available.java.lang.Long
getAssuredReplicationTimeoutMillis()
Retrieves the maximum length of time in milliseconds that the server will delay the response to the client while waiting for the replication assurance requirement to be satisfied.java.lang.String
getDiagnosticMessage()
Retrieves the diagnostic message for the operation.java.util.Set<java.lang.String>
getIndexesWithKeysAccessedExceedingEntryLimit()
Retrieves the names of any indexes for which one or more keys over the index entry limit were accessed while processing the operation.java.util.Set<java.lang.String>
getIndexesWithKeysAccessedNearEntryLimit()
Retrieves the names of any indexes for which one or more keys near (typically, within 80% of) the index entry limit were accessed while processing the operation.java.lang.String
getIntermediateClientResponseControl()
Retrieves a string representation of an intermediate client response control included in the log message.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.Set<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.Set<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.util.List<java.lang.String>
getReferralURLs()
Retrieves the list of referral URLs for the operation.java.lang.String
getReplicationChangeID()
Retrieves the replication change ID for the operation, if available.java.util.Set<java.lang.String>
getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.java.lang.Boolean
getResponseDelayedByAssurance()
Indicates whether the operation response to the client will be delayed until replication assurance has been satisfied or the timeout has occurred.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.lang.String
getUndeleteFromDN()
Retrieves the DN of the soft-deleted entry from which the contents of the added entry were obtained, if it was an undelete rather than a normal add.java.util.Set<java.lang.String>
getUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation.java.lang.Double
getWorkQueueWaitTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAddRequestAccessLogMessage
getAttributeNames, getDN, getOperationType
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AddRequestAccessLogMessage
getAttributeNames, getDN
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
-
-
-
Constructor Detail
-
TextFormattedAddResultAccessLogMessage
public TextFormattedAddResultAccessLogMessage(@NotNull java.lang.String logMessageString) throws LogException
Creates a new text-formatted add result access log message from the provided message string.- Parameters:
logMessageString
- The string representation of this log message. It must not benull
.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
-
Method Detail
-
getMessageType
@NotNull public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Specified by:
getMessageType
in interfaceAccessLogMessage
- Overrides:
getMessageType
in classTextFormattedRequestAccessLogMessage
- Returns:
- The message type for this access log message.
-
getResultCode
@Nullable public ResultCode getResultCode()
Retrieves the result code for the operation.- Specified by:
getResultCode
in interfaceOperationResultAccessLogMessage
- Returns:
- The result code for the operation, or
null
if it is not included in the log message.
-
getDiagnosticMessage
@Nullable public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for the operation.- Specified by:
getDiagnosticMessage
in interfaceOperationResultAccessLogMessage
- Returns:
- The diagnostic message for the operation, or
null
if it is not included in the log message.
-
getAdditionalInformation
@Nullable public java.lang.String getAdditionalInformation()
Retrieves a message with additional information about the result of the operation.- Specified by:
getAdditionalInformation
in interfaceOperationResultAccessLogMessage
- 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 public java.lang.String getMatchedDN()
Retrieves the matched DN for the operation.- Specified by:
getMatchedDN
in interfaceOperationResultAccessLogMessage
- Returns:
- The matched DN for the operation, or
null
if it is not included in the log message.
-
getReferralURLs
@NotNull public java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for the operation.- Specified by:
getReferralURLs
in interfaceOperationResultAccessLogMessage
- Returns:
- The list of referral URLs for the operation, or an empty list if it is not included in the log message.
-
getProcessingTimeMillis
@Nullable public java.lang.Double getProcessingTimeMillis()
Retrieves the length of time in milliseconds required to process the operation.- Specified by:
getProcessingTimeMillis
in interfaceOperationResultAccessLogMessage
- Returns:
- The length of time in milliseconds required to process the
operation, or
null
if it is not included in the log message.
-
getWorkQueueWaitTimeMillis
@Nullable public java.lang.Double getWorkQueueWaitTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue.- Specified by:
getWorkQueueWaitTimeMillis
in interfaceOperationResultAccessLogMessage
- 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.
-
getResponseControlOIDs
@NotNull public java.util.Set<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.- Specified by:
getResponseControlOIDs
in interfaceOperationResultAccessLogMessage
- Returns:
- The OIDs of any response controls contained in the log message, or an empty list if it is not included in the log message.
-
getIntermediateResponsesReturned
@Nullable public java.lang.Long getIntermediateResponsesReturned()
Retrieves the number of intermediate response messages returned in the course of processing the operation.- Specified by:
getIntermediateResponsesReturned
in interfaceOperationResultAccessLogMessage
- Returns:
- The number of intermediate response messages returned to the
client in the course of processing the operation, or
null
if it is not included in the log message.
-
getServersAccessed
@NotNull public java.util.List<java.lang.String> getServersAccessed()
Retrieves a list of the additional servers that were accessed in the course of processing the operation. For example, if the access log message is from a Directory Proxy Server instance, then this may contain a list of the backend servers used to process the operation.- Specified by:
getServersAccessed
in interfaceOperationResultAccessLogMessage
- Returns:
- A list of the additional servers that were accessed in the course of processing the operation, or an empty list if it is not included in the log message.
-
getUncachedDataAccessed
@Nullable public java.lang.Boolean getUncachedDataAccessed()
Indicates whether the server accessed any uncached data in the course of processing the operation.- Specified by:
getUncachedDataAccessed
in interfaceOperationResultAccessLogMessage
- Returns:
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, ornull
if it is not included in the log message (and the server likely did not access uncached data).
-
getUsedPrivileges
@NotNull public java.util.Set<java.lang.String> getUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation.- Specified by:
getUsedPrivileges
in interfaceOperationResultAccessLogMessage
- Returns:
- The names of any privileges used during the course of processing the operation, or an empty list if no privileges were used or this is not included in the log message.
-
getPreAuthorizationUsedPrivileges
@NotNull public java.util.Set<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.- Specified by:
getPreAuthorizationUsedPrivileges
in interfaceOperationResultAccessLogMessage
- Returns:
- The names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned, or an empty list if no privileges were used or this is not included in the log message.
-
getMissingPrivileges
@NotNull public java.util.Set<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.- Specified by:
getMissingPrivileges
in interfaceOperationResultAccessLogMessage
- Returns:
- The names of any privileges that would have been required for processing the operation but that the requester did not have, or an empty list if there were no missing privileges or this is not included in the log message.
-
getAlternateAuthorizationDN
@Nullable public final java.lang.String getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation.- Specified by:
getAlternateAuthorizationDN
in interfaceAddResultAccessLogMessage
- Returns:
- The alternate authorization DN for the operation, or
null
if it is not included in the log message.
-
getReplicationChangeID
@Nullable public final java.lang.String getReplicationChangeID()
Retrieves the replication change ID for the operation, if available.- Specified by:
getReplicationChangeID
in interfaceAddResultAccessLogMessage
- Returns:
- The replication change ID for the operation, or
null
if it is not included in the log message.
-
getAssuredReplicationLocalLevel
@Nullable public final AssuredReplicationLocalLevel getAssuredReplicationLocalLevel()
Retrieves the local level that will be used for assured replication processing, if available.- Specified by:
getAssuredReplicationLocalLevel
in interfaceAddResultAccessLogMessage
- Returns:
- The local level that will be used for assured replication
processing, or
null
if this is not included in the log message (e.g., because assured replication will not be performed for the operation).
-
getAssuredReplicationRemoteLevel
@Nullable public final AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel()
Retrieves the remote level that will be used for assured replication processing, if available.- Specified by:
getAssuredReplicationRemoteLevel
in interfaceAddResultAccessLogMessage
- Returns:
- The remote level that will be used for assured replication
processing, or
null
if this is not included in the log message (e.g., because assured replication will not be performed for the operation).
-
getAssuredReplicationTimeoutMillis
@Nullable public final java.lang.Long getAssuredReplicationTimeoutMillis()
Retrieves the maximum length of time in milliseconds that the server will delay the response to the client while waiting for the replication assurance requirement to be satisfied.- Specified by:
getAssuredReplicationTimeoutMillis
in interfaceAddResultAccessLogMessage
- Returns:
- The maximum length of time in milliseconds that the server will
delay the response to the client while waiting for the replication
assurance requirement to be satisfied, or
null
if this is not included in the log message (e.g., because assured replication will not be performed for the operation).
-
getResponseDelayedByAssurance
@Nullable public final java.lang.Boolean getResponseDelayedByAssurance()
Indicates whether the operation response to the client will be delayed until replication assurance has been satisfied or the timeout has occurred.- Specified by:
getResponseDelayedByAssurance
in interfaceAddResultAccessLogMessage
- Returns:
true
if the operation response to the client will be delayed until replication assurance has been satisfied,false
if the response will not be delayed by assurance processing, ornull
if this was not included in the log message (e.g., because assured replication will not be performed for the operation)
-
getIndexesWithKeysAccessedNearEntryLimit
@NotNull public final java.util.Set<java.lang.String> getIndexesWithKeysAccessedNearEntryLimit()
Retrieves the names of any indexes for which one or more keys near (typically, within 80% of) the index entry limit were accessed while processing the operation.- Specified by:
getIndexesWithKeysAccessedNearEntryLimit
in interfaceAddResultAccessLogMessage
- Returns:
- The names of any indexes for which one or more keys near the index entry limit were accessed while processing the operation, or an empty list if no such index keys were accessed, or if this is not included in the log message.
-
getIndexesWithKeysAccessedExceedingEntryLimit
@NotNull public final java.util.Set<java.lang.String> getIndexesWithKeysAccessedExceedingEntryLimit()
Retrieves the names of any indexes for which one or more keys over the index entry limit were accessed while processing the operation.- Specified by:
getIndexesWithKeysAccessedExceedingEntryLimit
in interfaceAddResultAccessLogMessage
- Returns:
- The names of any indexes for which one or more keys over the index entry limit were accessed while processing the operation, or an empty list if no such index keys were accessed, or if this is not included in the log message.
-
getIntermediateClientResponseControl
@Nullable public final java.lang.String getIntermediateClientResponseControl()
Retrieves a string representation of an intermediate client response control included in the log message.- Returns:
- A string representation of an intermediate client response control
included in the log message, or
null
if there is none.
-
getTargetHost
@Nullable public java.lang.String getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded.- Specified by:
getTargetHost
in interfaceOperationForwardAccessLogMessage
- Returns:
- The address of the backend server to which the request has been
forwarded, or
null
if it is not included in the log message.
-
getTargetPort
@Nullable public java.lang.Integer getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded.- Specified by:
getTargetPort
in interfaceOperationForwardAccessLogMessage
- Returns:
- The port of the backend server to which the request has been
forwarded, or
null
if it is not included in the log message.
-
getTargetProtocol
@Nullable public java.lang.String getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server.- Specified by:
getTargetProtocol
in interfaceOperationForwardAccessLogMessage
- Returns:
- The protocol used to forward the request to the backend server, or
null
if it is not included in the log message.
-
getUndeleteFromDN
@Nullable public final java.lang.String getUndeleteFromDN()
Retrieves the DN of the soft-deleted entry from which the contents of the added entry were obtained, if it was an undelete rather than a normal add.- Specified by:
getUndeleteFromDN
in interfaceAddResultAccessLogMessage
- Returns:
- The DN of the soft-deleted entry from which the contents of the
added entry were obtained, or
null
if it is not included in the log message (e.g., because the operation was a normal add rather than an undelete).
-
-