Package org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest

Class SyncRequestValueImpl

  • All Implemented Interfaces:
    SyncRequestValue, Control
    public class SyncRequestValueImpl
extends AbstractControl
implements SyncRequestValue
    A syncRequestValue object, as defined in RFC 4533 : 
     2.2.  Sync Request Control

    The Sync Request Control is an LDAP Control [RFC4511] where the
    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.1 and the
    controlValue, an OCTET STRING, contains a BER-encoded
    syncRequestValue.  The criticality field is either TRUE or FALSE.

       syncRequestValue ::= SEQUENCE {
           mode ENUMERATED {
               -- 0 unused
               refreshOnly       (1),
               -- 2 reserved
               refreshAndPersist (3)
           },
           cookie     syncCookie OPTIONAL,
           reloadHint BOOLEAN DEFAULT FALSE
       }

    The Sync Request Control is only applicable to the SearchRequest
    Message.
    Version:
    $Rev$, $Date$
    Author:
    Apache Directory Project