Package com.unboundid.ldap.sdk.controls

Class ContentSyncStateControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ContentSyncStateControl
All Implemented Interfaces:
DecodeableControl, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ContentSyncStateControl extends Control implements DecodeableControl
This class provides an implementation of the LDAP content synchronization state control as defined in RFC 4533. Directory servers may include this control in search result entry and search result reference messages returned for a search request containing the content synchronization request control. See the documentation for the ContentSyncRequestControl class for more information information about using the content synchronization operation.
See Also:

  • Field Details

  • Constructor Details

    • ContentSyncStateControl

      public ContentSyncStateControl(@NotNull ContentSyncState state, @NotNull UUID entryUUID, @Nullable ASN1OctetString cookie)
      Creates a new content synchronization state control that provides information about a search result entry or referenced returned by a search containing the content synchronization request control.
      Parameters:
      state - The sync state for the associated entry or reference. It must not be null.
      entryUUID - The entryUUID for the associated entry or reference. It must not be null.
      cookie - A cookie with an updated synchronization state. It may be null if no updated state is available.

    • ContentSyncStateControl

      public ContentSyncStateControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new content synchronization state 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 state control.

  • Method Details

    • decodeControl

      @NotNull public ContentSyncStateControl decodeControl(@NotNull 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 ContentSyncStateControl get(@NotNull SearchResultEntry entry) throws LDAPException
      Extracts a content sync state control from the provided search result entry.
      Parameters:
      entry - The search result entry from which to retrieve the content sync state control.
      Returns:
      The content sync state control contained in the provided search result entry, or null if the entry did not contain a content sync state control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the content sync state control contained in the provided search result entry.

    • get

      @Nullable public static ContentSyncStateControl get(@NotNull SearchResultReference ref) throws LDAPException
      Extracts a content sync state control from the provided search result reference.
      Parameters:
      ref - The search result reference from which to retrieve the content sync state control.
      Returns:
      The content sync state control contained in the provided search result reference, or null if the reference did not contain a content sync state control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the content sync state control contained in the provided search result reference.

    • getState

      @NotNull public ContentSyncState getState()
      Retrieves the synchronization state for this control, which provides information about the state of the associated search result entry or reference.
      Returns:
      The state value for this content synchronization state control.

    • getEntryUUID

      @NotNull public UUID getEntryUUID()
      Retrieves the entryUUID for the associated search result entry or reference.
      Returns:
      The entryUUID for the associated search result entry or reference.

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

    • getControlName

      @NotNull public 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 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.