Class NoticeOfDisconnectionExtendedResult

    • Constructor Detail

      • NoticeOfDisconnectionExtendedResult

        public NoticeOfDisconnectionExtendedResult​(@NotNull
                                                   ResultCode resultCode,
                                                   @Nullable
                                                   java.lang.String diagnosticMessage,
                                                   @Nullable
                                                   Control... responseControls)
        Creates a new instance of this notice of disconnection extended result from the provided generic extended result.
        Parameters:
        resultCode - The result code for the notice of disconnection.
        diagnosticMessage - The diagnostic message to include in the notice of disconnection. It may be null if no diagnostic message should be included.
        responseControls - The set of controls to include in the notice of disconnection. It may be null or empty if no response controls are needed.
      • NoticeOfDisconnectionExtendedResult

        public NoticeOfDisconnectionExtendedResult​(@NotNull
                                                   ExtendedResult extendedResult)
        Creates a new instance of this notice of disconnection extended result from the provided generic extended result.
        Parameters:
        extendedResult - The extended result to use to create this notice of disconnection extended result.
      • NoticeOfDisconnectionExtendedResult

        public NoticeOfDisconnectionExtendedResult​(@NotNull
                                                   LDAPException ldapException)
        Creates a new instance of this notice of disconnection extended result from the provided LDAP exception.
        Parameters:
        ldapException - The LDAP exception to use to create this notice of disconnection extended result.
      • NoticeOfDisconnectionExtendedResult

        public NoticeOfDisconnectionExtendedResult​(int messageID,
                                                   @NotNull
                                                   ResultCode resultCode,
                                                   @Nullable
                                                   java.lang.String diagnosticMessage,
                                                   @Nullable
                                                   java.lang.String matchedDN,
                                                   @Nullable
                                                   java.lang.String[] referralURLs,
                                                   @Nullable
                                                   Control[] responseControls)
        Creates a new instance of this notice of disconnection extended result from the provided information.
        Parameters:
        messageID - The message ID for the LDAP message that is associated with this LDAP result.
        resultCode - The result code from the response.
        diagnosticMessage - The diagnostic message from the response, if available.
        matchedDN - The matched DN from the response, if available.
        referralURLs - The set of referral URLs from the response, if available.
        responseControls - The set of controls from the response, if available.
    • Method Detail

      • getExtendedResultName

        @NotNull
        public java.lang.String getExtendedResultName()
        Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.
        Overrides:
        getExtendedResultName in class ExtendedResult
        Returns:
        The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this extended result to the provided buffer.
        Specified by:
        toString in interface LDAPResponse
        Overrides:
        toString in class ExtendedResult
        Parameters:
        buffer - The buffer to which a string representation of this extended result will be appended.