Package org.apache.directory.api.ldap.extras.controls.ad

Interface AdDirSyncResponse

  • All Superinterfaces:
    Control
    All Known Implementing Classes:
    AdDirSyncResponseImpl
    public interface AdDirSyncResponse
extends Control
    The DirSync response control, as described in http://tools.ietf.org/html/draft-armijo-ldap-dirsync-00. Here is the ASN/1 description of the SearchRequest control : 
     Repl    Control ::= SEQUENCE {
     controlType             1.2.840.113556.1.4.841
     controlValue            replControlValue
     criticality             TRUE
 }
    the control value is : 
     realReplControlValue ::= SEQUENCE {
     flag                  integer
     maxReturnLength       integer
     cookie                OCTET STRING
 }
    Author:
    Apache Directory Project

    • Method Detail

      • getMaxReturnLength

        int getMaxReturnLength()
        Returns:
        The maximum length of attributes to be returned

      • setMaxReturnLength

        void setMaxReturnLength​(int maxReturnLength)
        Parameters:
        maxReturnLength - The maximum length of attributes to be returned

      • getCookie

        byte[] getCookie()
        Returns:
        The cookie used while processing the successive DirSync operations

      • setCookie

        void setCookie​(byte[] cookie)
        Parameters:
        cookie - The cookie to send to the server. It's the value found in the response control. Should be null for the first control.

      • getFlags

        Set<AdDirSyncResponseFlag> getFlags()
        Returns:
        The flags returned by the server. Zero or more of :
        • LDAP_DIRSYNC_OBJECT_SECURITY (0x0001)
        • LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER (0x0800)
        • LDAP_DIRSYNC_PUBLIC_DATA_ONLY (0x2000)(
        • LDAP_DIRSYNC_INCREMENTAL_VALUES (0x7FFFFFFF)