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

Class BindResultAccessLogMessage

    • Constructor Detail

      • BindResultAccessLogMessage

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

      • BindResultAccessLogMessage

        public BindResultAccessLogMessage​(LogMessage m)
        Creates a new bind result access log message from the provided log message.
        Parameters:
        m - The log message to be parsed as a bind 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).

      • getAuthenticationDN

        public java.lang.String getAuthenticationDN()
        Retrieves the DN of the user authenticated by the bind operation.
        Returns:
        The DN of the user authenticated by the bind operation, or null if it is not included in the log message.

      • getAuthorizationDN

        public java.lang.String getAuthorizationDN()
        Retrieves the DN of the alternate authorization identity for the bind operation.
        Returns:
        The DN of the alternate authorization identity for the bind operation, or null if it is not included in the log message.

      • getAuthenticationFailureID

        public java.lang.Long getAuthenticationFailureID()
        Retrieves the numeric identifier for the authentication failure reason.
        Returns:
        The numeric identifier for the authentication failure reason, or null if it is not included in the log message.

      • getAuthenticationFailureReason

        public java.lang.String getAuthenticationFailureReason()
        Retrieves a message with information about the reason that the authentication attempt failed.
        Returns:
        A message with information about the reason that the authentication attempt failed, or null if it is not included in the log message.

      • getRetiredPasswordUsed

        public java.lang.Boolean getRetiredPasswordUsed()
        Indicates whether a retired password was used in the course of processing the bind.
        Returns:
        true if a retired password was used in the course of processing the bind, false if a retired password was not used in the course of processing the bind, or null if this was not included in the log message (and a retired password was likely not used in the course of processing the operation).

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

      • getClientConnectionPolicy

        public java.lang.String getClientConnectionPolicy()
        Retrieves the name of the client connection policy that was selected for the client connection.
        Returns:
        The name of the client connection policy that was selected for the client connection, 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.