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

Class TextFormattedAddResultAccessLogMessage

    • 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 be null.
        Throws:
        LogException - If the provided string cannot be parsed as a valid log message.

    • Method Detail

      • 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 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 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 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 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 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 AddResultAccessLogMessage
        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 AddResultAccessLogMessage
        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 AddResultAccessLogMessage
        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 interface AddResultAccessLogMessage
        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 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 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.

      • 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 interface AddResultAccessLogMessage
        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).