Interface DeleteResultAccessLogMessage
-
- All Superinterfaces:
AccessLogMessage
,DeleteForwardAccessLogMessage
,DeleteRequestAccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationRequestAccessLogMessage
,OperationResultAccessLogMessage
,java.io.Serializable
- All Known Subinterfaces:
DeleteAssuranceCompletedAccessLogMessage
- All Known Implementing Classes:
JSONDeleteAssuranceCompletedAccessLogMessage
,JSONDeleteResultAccessLogMessage
,TextFormattedDeleteAssuranceCompletedAccessLogMessage
,TextFormattedDeleteResultAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface DeleteResultAccessLogMessage extends OperationResultAccessLogMessage, DeleteForwardAccessLogMessage
This class provides a data structure that holds information about a delete operation 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.Boolean
getChangeToSoftDeletedEntry()
Indicates whether the delete operation targeted a soft-deleted entry.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
getReplicationChangeID()
Retrieves the replication change ID for the operation, if available.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.java.lang.String
getSoftDeletedEntryDN()
Retrieves the DN of the soft-deleted entry that was created as a result of this operation, if it was a soft delete rather than a normal hard delete.-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.DeleteRequestAccessLogMessage
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.OperationForwardAccessLogMessage
getTargetHost, getTargetPort, getTargetProtocol
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationResultAccessLogMessage
getAdditionalInformation, getDiagnosticMessage, getIntermediateResponsesReturned, getMatchedDN, getMissingPrivileges, getPreAuthorizationUsedPrivileges, getProcessingTimeMillis, getReferralURLs, getResponseControlOIDs, getResultCode, getServersAccessed, getUncachedDataAccessed, getUsedPrivileges, getWorkQueueWaitTimeMillis
-
-
-
-
Method Detail
-
getAlternateAuthorizationDN
@Nullable java.lang.String getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation.- Returns:
- The alternate authorization DN for the operation, or
null
if it is not included in the log message.
-
getReplicationChangeID
@Nullable java.lang.String getReplicationChangeID()
Retrieves the replication change ID for the operation, if available.- Returns:
- The replication change ID for the operation, or
null
if it is not included in the log message.
-
getSoftDeletedEntryDN
@Nullable java.lang.String getSoftDeletedEntryDN()
Retrieves the DN of the soft-deleted entry that was created as a result of this operation, if it was a soft delete rather than a normal hard delete.- Returns:
- The DN of the soft-deleted entry that was created as a result of
this operation, or
null
if it is not included in the log message (e.g., because the operation was a hard delete rather than a soft delete).
-
getChangeToSoftDeletedEntry
@Nullable java.lang.Boolean getChangeToSoftDeletedEntry()
Indicates whether the delete operation targeted a soft-deleted entry.- Returns:
true
if the delete operation was known to target a soft-deleted entry,false
if it was known to target a non-soft-deleted entry, ornull
if it is not included in the log message (and likely did not target a soft-deleted entry).
-
getAssuredReplicationLocalLevel
@Nullable AssuredReplicationLocalLevel getAssuredReplicationLocalLevel()
Retrieves the local level that will be used for assured replication processing, if available.- 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 AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel()
Retrieves the remote level that will be used for assured replication processing, if available.- 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 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.- 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 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.- 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 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.- 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 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.- 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.
-
-