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 { flags integer maxBytes integer cookie OCTET STRING }
orServer side : realReplControlValue ::= SEQUENCE { flag integer maxReturnLength integer cookie OCTET STRING }
- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addFlag(AdDirSyncFlag flag)
byte[]
getCookie()
Set<AdDirSyncFlag>
getFlags()
int
getMaxReturnLength()
void
removeFlag(AdDirSyncFlag flag)
void
setCookie(byte[] cookie)
void
setFlags(Set<AdDirSyncFlag> flags)
void
setMaxReturnLength(int maxReturnLength)
-
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
-
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<AdDirSyncFlag> 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)
-
setFlags
void setFlags(Set<AdDirSyncFlag> flags)
- Parameters:
flags
- The flags to be set. SeeEnumSet
for how to generate EnumSets.
-
addFlag
void addFlag(AdDirSyncFlag flag)
- Parameters:
flag
- The flag to be added to the current collection of flags.
-
removeFlag
void removeFlag(AdDirSyncFlag flag)
- Parameters:
flag
- The flag to be removed from the current collection of flags.
-
-