Package org.apache.directory.api.ldap.extras.intermediate.syncrepl

Interface SyncInfoValue

  • All Superinterfaces:
    IntermediateResponse, Message, Response, ResultResponse
    All Known Implementing Classes:
    SyncInfoValueImpl
    public interface SyncInfoValue
extends IntermediateResponse
    A syncInfoValue object, as defined in RFC 4533 ; 
     2.5.  Sync Info Message

    The Sync Info Message is an LDAP Intermediate Response Message
    [RFC4511] where responseName is the object identifier
    1.3.6.1.4.1.4203.1.9.1.4 and responseValue contains a BER-encoded
    syncInfoValue.  The criticality is FALSE (and hence absent).

       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
           }
       }
    Author:
    Apache Directory Project

    • Method Detail

      • getSyncInfoValueType

        SynchronizationInfoEnum getSyncInfoValueType()
        Get the value type.
        Returns:
        the type : one of newCookie, refreshDelete, refreshPresent or syncIdSet

      • setSyncInfoValueType

        void setSyncInfoValueType​(SynchronizationInfoEnum type)
        Parameters:
        type - the synchronization type to set

      • getCookie

        byte[] getCookie()
        Returns:
        the cookie

      • setCookie

        void setCookie​(byte[] cookie)
        Parameters:
        cookie - the cookie to set

      • isRefreshDone

        boolean isRefreshDone()
        Returns:
        the refreshDone

      • setRefreshDone

        void setRefreshDone​(boolean refreshDone)
        Parameters:
        refreshDone - the refreshDone to set

      • isRefreshDeletes

        boolean isRefreshDeletes()
        Returns:
        the refreshDeletes

      • setRefreshDeletes

        void setRefreshDeletes​(boolean refreshDeletes)
        Parameters:
        refreshDeletes - the refreshDeletes to set

      • getSyncUUIDs

        List<byte[]> getSyncUUIDs()
        Returns:
        the syncUUIDs

      • setSyncUUIDs

        void setSyncUUIDs​(List<byte[]> syncUUIDs)
        Parameters:
        syncUUIDs - the syncUUIDs to set

      • addSyncUUID

        void addSyncUUID​(byte[] syncUUID)
        Parameters:
        syncUUID - the syncUUIDs to set