@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class JSONDeleteResultAccessLogMessage extends JSONDeleteRequestAccessLogMessage implements DeleteResultAccessLogMessage
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.
Constructor and Description |
---|
JSONDeleteResultAccessLogMessage(JSONObject jsonObject)
Creates a new JSON delete result access log message from the provided JSON
object.
|
Modifier and Type | Method and 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.Boolean |
getChangeToSoftDeletedEntry()
Indicates whether the delete operation targeted a soft-deleted entry.
|
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.
|
JSONIntermediateClientResponseControl |
getIntermediateClientResponseControl()
Retrieves information about 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 |
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.
|
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.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.
|
getDN, getOperationType
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getJSONObject, getLogType, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDN
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
public JSONDeleteResultAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
jsonObject
- The JSON object that contains an encoded representation
of this log message. It must not be null
.LogException
- If the provided JSON object cannot be parsed as a
valid log message.@NotNull public AccessLogMessageType getMessageType()
getMessageType
in interface AccessLogMessage
getMessageType
in class JSONRequestAccessLogMessage
@Nullable public final ResultCode getResultCode()
getResultCode
in interface OperationResultAccessLogMessage
null
if it is not
included in the log message.@Nullable public final java.lang.String getDiagnosticMessage()
getDiagnosticMessage
in interface OperationResultAccessLogMessage
null
if it is
not included in the log message.@Nullable public final java.lang.String getAdditionalInformation()
getAdditionalInformation
in interface OperationResultAccessLogMessage
null
if it is not included in the log
message.@Nullable public final java.lang.String getMatchedDN()
getMatchedDN
in interface OperationResultAccessLogMessage
null
if it is not
included in the log message.@NotNull public final java.util.List<java.lang.String> getReferralURLs()
getReferralURLs
in interface OperationResultAccessLogMessage
@Nullable public final java.lang.Double getProcessingTimeMillis()
getProcessingTimeMillis
in interface OperationResultAccessLogMessage
null
if it is not included in the log
message.@Nullable public final java.lang.Double getWorkQueueWaitTimeMillis()
getWorkQueueWaitTimeMillis
in interface OperationResultAccessLogMessage
null
if it is not included in
the log message.@NotNull public final java.util.Set<java.lang.String> getResponseControlOIDs()
getResponseControlOIDs
in interface OperationResultAccessLogMessage
@Nullable public final java.lang.Long getIntermediateResponsesReturned()
getIntermediateResponsesReturned
in interface OperationResultAccessLogMessage
null
if it is not included in the log message.@NotNull public final java.util.List<java.lang.String> getServersAccessed()
getServersAccessed
in interface OperationResultAccessLogMessage
@Nullable public final java.lang.Boolean getUncachedDataAccessed()
getUncachedDataAccessed
in interface OperationResultAccessLogMessage
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).@NotNull public final java.util.Set<java.lang.String> getUsedPrivileges()
getUsedPrivileges
in interface OperationResultAccessLogMessage
@NotNull public final java.util.Set<java.lang.String> getPreAuthorizationUsedPrivileges()
getPreAuthorizationUsedPrivileges
in interface OperationResultAccessLogMessage
@NotNull public final java.util.Set<java.lang.String> getMissingPrivileges()
getMissingPrivileges
in interface OperationResultAccessLogMessage
@Nullable public final java.lang.String getAlternateAuthorizationDN()
getAlternateAuthorizationDN
in interface DeleteResultAccessLogMessage
null
if it is not included in the log message.@Nullable public final java.lang.String getReplicationChangeID()
getReplicationChangeID
in interface DeleteResultAccessLogMessage
null
if it
is not included in the log message.@Nullable public final AssuredReplicationLocalLevel getAssuredReplicationLocalLevel()
getAssuredReplicationLocalLevel
in interface DeleteResultAccessLogMessage
null
if this is not included in the log
message (e.g., because assured replication will not be performed
for the operation).@Nullable public final AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel()
getAssuredReplicationRemoteLevel
in interface DeleteResultAccessLogMessage
null
if this is not included in the log
message (e.g., because assured replication will not be performed
for the operation).@Nullable public final java.lang.Long getAssuredReplicationTimeoutMillis()
getAssuredReplicationTimeoutMillis
in interface DeleteResultAccessLogMessage
null
if this is
not included in the log message (e.g., because assured replication
will not be performed for the operation).@Nullable public final java.lang.Boolean getResponseDelayedByAssurance()
getResponseDelayedByAssurance
in interface DeleteResultAccessLogMessage
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, or null
if this was not included in the
log message (e.g., because assured replication will not be
performed for the operation)@NotNull public final java.util.Set<java.lang.String> getIndexesWithKeysAccessedNearEntryLimit()
getIndexesWithKeysAccessedNearEntryLimit
in interface DeleteResultAccessLogMessage
@NotNull public final java.util.Set<java.lang.String> getIndexesWithKeysAccessedExceedingEntryLimit()
getIndexesWithKeysAccessedExceedingEntryLimit
in interface DeleteResultAccessLogMessage
@Nullable public final JSONIntermediateClientResponseControl getIntermediateClientResponseControl()
null
if no intermediate client response
control is available.@Nullable public final java.lang.String getTargetHost()
getTargetHost
in interface OperationForwardAccessLogMessage
null
if it is not included in the log
message.@Nullable public final java.lang.Integer getTargetPort()
getTargetPort
in interface OperationForwardAccessLogMessage
null
if it is not included in the log
message.@Nullable public final java.lang.String getTargetProtocol()
getTargetProtocol
in interface OperationForwardAccessLogMessage
null
if it is not included in the log message.@Nullable public final java.lang.String getSoftDeletedEntryDN()
getSoftDeletedEntryDN
in interface DeleteResultAccessLogMessage
null
if it is not included in the log
message (e.g., because the operation was a hard delete rather than
a soft delete).@Nullable public final java.lang.Boolean getChangeToSoftDeletedEntry()
getChangeToSoftDeletedEntry
in interface DeleteResultAccessLogMessage
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, or null
if it is not included in
the log message (and likely did not target a soft-deleted entry).