Class ChangeSequenceNumberResponseControl

    • Constructor Detail

      • ChangeSequenceNumberResponseControl

        public ChangeSequenceNumberResponseControl​(@NotNull
                                                   java.lang.String csn)
        Creates a new change sequence number response control with the provided CSN.
        Parameters:
        csn - The change sequence number returned by the server. It must not be null.
      • ChangeSequenceNumberResponseControl

        public ChangeSequenceNumberResponseControl​(@NotNull
                                                   java.lang.String oid,
                                                   boolean isCritical,
                                                   @Nullable
                                                   ASN1OctetString value)
                                            throws LDAPException
        Creates a new change sequence number response control with the provided information.
        Parameters:
        oid - The OID for the control.
        isCritical - Indicates whether the control should be marked critical.
        value - The encoded value for the control. This may be null if no value was provided.
        Throws:
        LDAPException - If the provided control cannot be decoded as a change sequence number response control.
    • Method Detail

      • get

        @Nullable
        public static ChangeSequenceNumberResponseControl get​(@NotNull
                                                              LDAPResult result)
                                                       throws LDAPException
        Extracts a change sequence number response control from the provided result.
        Parameters:
        result - The result from which to retrieve the change sequence number response control.
        Returns:
        The change sequence number response control contained in the provided result, or null if the result did not contain a change sequence number response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the change sequence number response control contained in the provided result.
      • getCSN

        @NotNull
        public java.lang.String getCSN()
        Retrieves the CSN returned by the server.
        Returns:
        The CSN returned by the server.
      • getControlName

        @NotNull
        public java.lang.String getControlName()
        Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
        Overrides:
        getControlName in class Control
        Returns:
        The user-friendly name for this control, or the OID if no user-friendly name is available.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this LDAP control to the provided buffer.
        Overrides:
        toString in class Control
        Parameters:
        buffer - The buffer to which to append the string representation of this buffer.