Class SyncInfoMessage

All Implemented Interfaces:
Message

public class SyncInfoMessage extends IntermediateResponse
Intermediate response message for LDAP content synchronization. See RFC 4533. Message is defined as:
   IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
     responseName     [0] LDAPOID OPTIONAL,
     responseValue    [1] OCTET STRING OPTIONAL }


   syncInfoValue ::= CHOICE {
     newcookie      [0] syncCookie,
     refreshDelete  [1] SEQUENCE {
       cookie         syncCookie OPTIONAL,
       refreshDone    BOOLEAN DEFAULT TRUE
     },
     refreshPresent [2] SEQUENCE {
       cookie         syncCookie OPTIONAL,
       refreshDone    BOOLEAN DEFAULT TRUE
     },
     syncIdSet      [3] SEQUENCE {
       cookie         syncCookie OPTIONAL,
       refreshDeletes BOOLEAN DEFAULT FALSE,
       syncUUIDs      SET OF syncUUID
     }
   }
 
  • Field Details

    • OID

      public static final String OID
      OID of this response.
      See Also:
    • HASH_CODE_SEED

      private static final int HASH_CODE_SEED
      hash code seed.
      See Also:
    • REFRESH_DELETE_PATH

      private static final DERPath REFRESH_DELETE_PATH
      DER path to refresh delete.
    • REFRESH_DELETE_DONE_PATH

      private static final DERPath REFRESH_DELETE_DONE_PATH
      DER path to refresh delete done.
    • REFRESH_PRESENT_PATH

      private static final DERPath REFRESH_PRESENT_PATH
      DER path to refresh present.
    • REFRESH_PRESENT_DONE_PATH

      private static final DERPath REFRESH_PRESENT_DONE_PATH
      DER path to refresh present done.
    • SYNC_ID_SET_PATH

      private static final DERPath SYNC_ID_SET_PATH
      DER path to sync ID set.
    • SYNC_ID_SET_DELETES_PATH

      private static final DERPath SYNC_ID_SET_DELETES_PATH
      DER path to sync ID set deletes.
    • SYNC_ID_SET_UUIDS_PATH

      private static final DERPath SYNC_ID_SET_UUIDS_PATH
      DER path to sync ID set UUIDS.
    • messageType

      private SyncInfoMessage.Type messageType
      message type.
    • refreshDone

      private boolean refreshDone
      refresh done.
    • refreshDeletes

      private boolean refreshDeletes
      refresh deletes.
    • entryUuids

      private Set<UUID> entryUuids
      entry uuids.
  • Constructor Details

    • SyncInfoMessage

      protected SyncInfoMessage()
      Default constructor.
    • SyncInfoMessage

      public SyncInfoMessage(DERBuffer buffer)
      Creates a new sync info message.
      Parameters:
      buffer - to decode
  • Method Details

    • getResponseValueParseHandler

      protected ParseHandler getResponseValueParseHandler()
      Returns the parse handler for the response value.
      Overrides:
      getResponseValueParseHandler in class IntermediateResponse
      Returns:
      parse handler
    • getMessageType

      public SyncInfoMessage.Type getMessageType()
      Returns the message type.
      Returns:
      message type
    • setMessageType

      public void setMessageType(SyncInfoMessage.Type type)
      Sets the message type.
      Parameters:
      type - message type
    • getCookie

      public byte[] getCookie()
      Returns the sync request cookie.
      Returns:
      sync request cookie
    • setCookie

      public void setCookie(byte[] value)
      Sets the sync request cookie.
      Parameters:
      value - sync request cookie
    • getRefreshDone

      public boolean getRefreshDone()
      Returns whether refreshes are done.
      Returns:
      refresh done
    • setRefreshDone

      public void setRefreshDone(boolean b)
      Sets whether refreshes are done.
      Parameters:
      b - refresh done
    • getRefreshDeletes

      public boolean getRefreshDeletes()
      Returns whether to refresh deletes.
      Returns:
      whether to refresh deletes
    • setRefreshDeletes

      public void setRefreshDeletes(boolean b)
      Sets whether to refresh deletes.
      Parameters:
      b - whether to refresh deletes
    • getEntryUuids

      public Set<UUID> getEntryUuids()
      Returns the entry uuids.
      Returns:
      entry uuids
    • addEntryUuids

      public void addEntryUuids(UUID... uuids)
      Adds the supplied UUIDs to this message.
      Parameters:
      uuids - to add
    • setEntryUuids

      public void setEntryUuids(Set<UUID> uuids)
      Sets the entry uuids.
      Parameters:
      uuids - entry uuids
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class IntermediateResponse
    • hashCode

      public int hashCode()
      Description copied from class: AbstractMessage
      Returns the hash code for this object.
      Overrides:
      hashCode in class IntermediateResponse
      Returns:
      hash code
    • toString

      public String toString()
      Overrides:
      toString in class IntermediateResponse
    • builder

      public static SyncInfoMessage.Builder builder()
      Creates a builder for this class.
      Returns:
      new builder