Package com.unboundid.ldap.sdk.unboundidds.logs.v2.json

Class JSONDeleteResultAccessLogMessage

    • Constructor Detail

      • JSONDeleteResultAccessLogMessage

        public JSONDeleteResultAccessLogMessage​(@NotNull
                                        JSONObject jsonObject)
                                 throws LogException
        Creates a new JSON delete result access log message from the provided JSON object.
        Parameters:
        jsonObject - The JSON object that contains an encoded representation of this log message. It must not be null.
        Throws:
        LogException - If the provided JSON object cannot be parsed as a valid log message.

    • Method Detail

      • getServersAccessed

        @NotNull
public final 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 interface OperationResultAccessLogMessage
        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 final java.lang.Boolean getUncachedDataAccessed()
        Indicates whether the server accessed any uncached data in the course of processing the operation.
        Specified by:
        getUncachedDataAccessed in interface OperationResultAccessLogMessage
        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, or null if it is not included in the log message (and the server likely did not access uncached data).

      • getUsedPrivileges

        @NotNull
public final 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 interface OperationResultAccessLogMessage
        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 final 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 interface OperationResultAccessLogMessage
        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 final 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 interface OperationResultAccessLogMessage
        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.

      • 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 interface DeleteResultAccessLogMessage
        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 interface DeleteResultAccessLogMessage
        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, or null 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 interface DeleteResultAccessLogMessage
        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.

      • getTargetHost

        @Nullable
public final java.lang.String getTargetHost()
        Retrieves the address of the backend server to which the request has been forwarded.
        Specified by:
        getTargetHost in interface OperationForwardAccessLogMessage
        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 final java.lang.Integer getTargetPort()
        Retrieves the port of the backend server to which the request has been forwarded.
        Specified by:
        getTargetPort in interface OperationForwardAccessLogMessage
        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.

      • getSoftDeletedEntryDN

        @Nullable
public final 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.
        Specified by:
        getSoftDeletedEntryDN in interface DeleteResultAccessLogMessage
        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
public final java.lang.Boolean getChangeToSoftDeletedEntry()
        Indicates whether the delete operation targeted a soft-deleted entry.
        Specified by:
        getChangeToSoftDeletedEntry in interface DeleteResultAccessLogMessage
        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, or null if it is not included in the log message (and likely did not target a soft-deleted entry).