Class ExtendedForwardFailedAccessLogMessage

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class ExtendedForwardFailedAccessLogMessage
    extends ExtendedRequestAccessLogMessage
    This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an extended request that was forwarded to a backend server but did not complete successfully.
    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.
    See Also:
    Serialized Form
    • Constructor Detail

      • ExtendedForwardFailedAccessLogMessage

        public ExtendedForwardFailedAccessLogMessage​(@NotNull
                                                     java.lang.String s)
                                              throws LogException
        Creates a new extended forward failed access log message from the provided message string.
        Parameters:
        s - The string to be parsed as an extended forward failed access log message.
        Throws:
        LogException - If the provided string cannot be parsed as a valid log message.
      • ExtendedForwardFailedAccessLogMessage

        public ExtendedForwardFailedAccessLogMessage​(@NotNull
                                                     LogMessage m)
        Creates a new extended forward failed access log message from the provided log message.
        Parameters:
        m - The log message to be parsed as an extended forward failed access log message.
    • Method Detail

      • getTargetHost

        @Nullable
        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

        @Nullable
        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

        @Nullable
        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.
      • getResultCode

        @Nullable
        public java.lang.Integer getResultCode()
        Retrieves the result code received for the forwarded operation.
        Returns:
        The result code received for the forwarded operation, or null if it is not included in the log message.
      • getDiagnosticMessage

        @Nullable
        public java.lang.String getDiagnosticMessage()
        Retrieves the diagnostic message received for the forwarded operation.
        Returns:
        The diagnostic message received for the forwarded operation, or null if it is not included in the log message.