Class ContentSyncDoneControl

    • Constructor Detail

      • ContentSyncDoneControl

        public ContentSyncDoneControl​(@Nullable
                                      ASN1OctetString cookie,
                                      boolean refreshDeletes)
        Creates a new content synchronization done control that provides updated information about the state of a content synchronization session.
        Parameters:
        cookie - A cookie with an updated synchronization state. It may be null if no updated state is available.
        refreshDeletes - Indicates whether the synchronization processing has completed a delete phase.
      • ContentSyncDoneControl

        public ContentSyncDoneControl​(@NotNull
                                      java.lang.String oid,
                                      boolean isCritical,
                                      @Nullable
                                      ASN1OctetString value)
                               throws LDAPException
        Creates a new content synchronization done control which is decoded from the provided information from a generic control.
        Parameters:
        oid - The OID for the control used to create this control.
        isCritical - Indicates whether the control is marked critical.
        value - The encoded value for the control.
        Throws:
        LDAPException - If the provided control cannot be decoded as a content synchronization done control.
    • Method Detail

      • decodeControl

        @NotNull
        public ContentSyncDoneControl decodeControl​(@NotNull
                                                    java.lang.String oid,
                                                    boolean isCritical,
                                                    @Nullable
                                                    ASN1OctetString value)
                                             throws LDAPException
        Creates a new instance of this decodeable control from the provided information.
        Specified by:
        decodeControl in interface DecodeableControl
        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.
        Returns:
        The decoded representation of this control.
        Throws:
        LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.
      • get

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

        @Nullable
        public ASN1OctetString getCookie()
        Retrieves a cookie providing updated state information for the synchronization session, if available.
        Returns:
        A cookie providing updated state information for the synchronization session, or null if none was included in the control.
      • refreshDeletes

        public boolean refreshDeletes()
        Indicates whether the synchronization processing has completed a delete phase.
        Returns:
        true if the synchronization processing has completed a delete phase, or false if not.
      • 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.