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

Class AdDirSyncImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.controls.AbstractControl

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

All Implemented Interfaces:

AdDirSync, Control

public class AdDirSyncImpl
extends AbstractControl
implements AdDirSync

The class implemnting the AdDirsSync interface

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	cookie The DirSync cookie
(package private) AdDirSyncFlag	flag A flag used to indicate that there are more data to return
(package private) int	maxReturnLength The maximum number of attributes to return
(package private) int	parentFirst A flag used to tell the server to return the parent before the children

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

OID

Constructor Summary

Constructors

Constructor and Description
AdDirSyncImpl() Creates an instance of the DirSync control

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
byte[]	getCookie()
AdDirSyncFlag	getFlag()
int	getMaxReturnLength()
int	getParentFirst()
int	hashCode()
void	setCookie(byte[] cookie)
void	setFlag(AdDirSyncFlag flag)
void	setMaxReturnLength(int maxReturnLength)
void	setParentFirst(int parentFirst)
java.lang.String	toString() Return a String representing a Control

Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl

getOid, isCritical, setCritical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getOid, isCritical, setCritical

Field Detail

parentFirst

int parentFirst

A flag used to tell the server to return the parent before the children

flag

AdDirSyncFlag flag

A flag used to indicate that there are more data to return

maxReturnLength

int maxReturnLength

The maximum number of attributes to return

cookie

private byte[] cookie

The DirSync cookie

Constructor Detail

AdDirSyncImpl

public AdDirSyncImpl()

Creates an instance of the DirSync control

Method Detail

getParentFirst

public int getParentFirst()

Specified by:

getParentFirst in interface AdDirSync

Returns:

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

setParentFirst

public void setParentFirst(int parentFirst)

Specified by:

setParentFirst in interface AdDirSync

Parameters:

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

getFlag

public AdDirSyncFlag getFlag()

Specified by:

getFlag in interface AdDirSync

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

public void setFlag(AdDirSyncFlag flag)

Specified by:

setFlag in interface AdDirSync

Parameters:

flag - The flag.

getMaxReturnLength

public int getMaxReturnLength()

Specified by:

getMaxReturnLength in interface AdDirSync

Returns:

The maximum length of attributes to be returned

setMaxReturnLength

public void setMaxReturnLength(int maxReturnLength)

Specified by:

setMaxReturnLength in interface AdDirSync

Parameters:

maxReturnLength - The maximum length of attributes to be returned

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface AdDirSync

Returns:

The cookie used while processing the successive DirSync operations

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface AdDirSync

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.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractControl

See Also:

Object.equals(Object)

toString

public java.lang.String toString()

Description copied from class: AbstractControl

Return a String representing a Control

Overrides:

toString in class AbstractControl

See Also:

Object.toString()