Class SearchResultAccessLogMessage

    • Constructor Detail

      • SearchResultAccessLogMessage

        public SearchResultAccessLogMessage​(java.lang.String s)
                                     throws LogException
        Creates a new search result access log message from the provided message string.
        Parameters:
        s - The string to be parsed as a search result access log message.
        Throws:
        LogException - If the provided string cannot be parsed as a valid log message.
      • SearchResultAccessLogMessage

        public SearchResultAccessLogMessage​(LogMessage m)
        Creates a new search result access log message from the provided log message.
        Parameters:
        m - The log message to be parsed as a search result access log message.
    • Method Detail

      • getQueueTimeMillis

        public java.lang.Double getQueueTimeMillis()
        Retrieves the length of time in milliseconds the operation was required to wait on the work queue.
        Specified by:
        getQueueTimeMillis in interface MinimalOperationResultAccessLogMessage
        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

        public java.util.List<java.lang.String> getResponseControlOIDs()
        Retrieves the OIDs of any response controls contained in the log message.
        Specified by:
        getResponseControlOIDs in interface OperationResultAccessLogMessage
        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.
      • getServersAccessed

        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

        public java.lang.Boolean getUncachedDataAccessed()
        Indicates whether the server accessed any uncached data in the course of processing the operation.
        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).
      • getEntriesReturned

        public java.lang.Long getEntriesReturned()
        Retrieves the number of entries returned to the client.
        Returns:
        The number of entries returned to the client, or null if it is not included in the log message.
      • isUnindexed

        public java.lang.Boolean isUnindexed()
        Indicates whether the search was unindexed.
        Returns:
        Boolean.TRUE if the search was unindexed, Boolean.FALSE if it was not, or null if it is not included in the log message.
      • getAlternateAuthorizationDN

        public 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.
      • getTargetHost

        public java.lang.String getTargetHost()
        Retrieves the address of the backend server to which the request has been forwarded.
        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

        public java.lang.Integer getTargetPort()
        Retrieves the port of the backend server to which the request has been forwarded.
        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

        public java.lang.String getTargetProtocol()
        Retrieves the protocol used to forward the request to the backend server.
        Returns:
        The protocol used to forward the request to the backend server, or null if it is not included in the log message.
      • getUsedPrivileges

        public java.util.List<java.lang.String> getUsedPrivileges()
        Retrieves the names of any privileges used during the course of processing the operation.
        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

        public java.util.List<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.
        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

        public java.util.List<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.
        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.
      • getIndexesWithKeysAccessedNearEntryLimit

        public java.util.List<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.
      • getIndexesWithKeysAccessedOverEntryLimit

        public java.util.List<java.lang.String> getIndexesWithKeysAccessedOverEntryLimit()
        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.