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

Interface AdDirSync

All Superinterfaces:

Control

All Known Implementing Classes:

AdDirSyncDecorator, AdDirSyncImpl

public interface AdDirSync
extends Control

The DirSync control, as described in http://tools.ietf.org/html/draft-armijo-ldap-dirsync-00. We use the same control for both the SearchRequest and the SearchResultDone. 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 can be one of the two structures :
 
 Client side :
 realReplControlValue ::= SEQUENCE {
     parentsFirst            integer
     maxReturnLength         integer
     cookie                  OCTET STRING
 }
 
 or
 
 server side :
 realReplControlValue ::= SEQUENCE {
     flag                  integer
     maxReturnLength       integer
     cookie                OCTET STRING
 }
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	OID This control OID

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getCookie()
AdDirSyncFlag	getFlag()
int	getMaxReturnLength()
int	getParentFirst()
void	setCookie(byte[] cookie)
void	setFlag(AdDirSyncFlag flag)
void	setMaxReturnLength(int maxReturnLength)
void	setParentFirst(int parentFirst)

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

This control OID

See Also:

Constant Field Values

Method Detail

getParentFirst

int getParentFirst()

Returns:

1 if the parents are guaranteed to be returned before the children.

setParentFirst

void setParentFirst(int parentFirst)

Parameters:

parentFirst - The parentFirst flag. A value of 1 will tell the server to return the parents first.

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.

getFlag

AdDirSyncFlag getFlag()

Returns:

The flag returned by the server. One of :

• LDAP_DIRSYNC_OBJECT_SECURITY (0x0001)
• LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER (0x0800)
• LDAP_DIRSYNC_PUBLIC_DATA_ONLY (0x2000)(
• LDAP_DIRSYNC_INCREMENTAL_VALUES (0x7FFFFFFF)

setFlag

void setFlag(AdDirSyncFlag flag)

Parameters:

flag - The flag.