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

Interface AdDirSyncRequest

  • All Superinterfaces:
    Control
    All Known Implementing Classes:
    AdDirSyncRequestImpl
    public interface AdDirSyncRequest
extends Control
    The DirSync request 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 : 
     Client side :
 realReplControlValue ::= SEQUENCE {
     parentsFirst            integer
     maxAttributeCount       integer
     cookie                  OCTET STRING
 }
    Author:
    Apache Directory Project

    • Method Detail

      • getParentsFirst

        int getParentsFirst()
        Returns:
        1 if the parents of the children comes before their children

      • setParentsFirst

        void setParentsFirst​(int parentsFirst)
        Tell the server that it should send the parents of the children before their children. NOTE: it should have been a boolean, it's an integer instead.
        Parameters:
        parentsFirst - When set to 1, will return the parents before children

      • getMaxAttributeCount

        int getMaxAttributeCount()
        Returns:
        The maximum attribute count to be returned

      • setMaxAttributeCount

        void setMaxAttributeCount​(int maxAttributeCount)
        Parameters:
        maxAttributeCount - The maximum attribute count 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.