Package 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

Author:

Apache Directory Project

Field Summary

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

OID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addFlag(AdDirSyncFlag flag)
boolean	equals(Object other)
byte[]	getCookie()
Set<AdDirSyncFlag>	getFlags()
int	getMaxReturnLength()
int	hashCode()
void	removeFlag(AdDirSyncFlag flag)
void	setCookie(byte[] cookie)
void	setFlags(Set<AdDirSyncFlag> flags)
void	setMaxReturnLength(int maxReturnLength)
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

getClass, notify, notifyAll, wait, wait, wait

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

getOid, isCritical, setCritical

Constructor Detail

AdDirSyncImpl

public AdDirSyncImpl()

Creates an instance of the DirSync control

Method Detail

getFlags

public Set<AdDirSyncFlag> getFlags()

Specified by:

getFlags in interface AdDirSync

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

public void setFlags(Set<AdDirSyncFlag> flags)

Specified by:

setFlags in interface AdDirSync

Parameters:

flags - The flags to be set. See EnumSet for how to generate EnumSets.

addFlag

public void addFlag(AdDirSyncFlag flag)

Specified by:

addFlag in interface AdDirSync

Parameters:

flag - The flag to be added to the current collection of flags.

removeFlag

public void removeFlag(AdDirSyncFlag flag)

Specified by:

removeFlag in interface AdDirSync

Parameters:

flag - The flag to be removed from the current collection of flags.

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(Object other)

Overrides:

equals in class AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Description copied from class: AbstractControl

Return a String representing a Control

Overrides:

toString in class AbstractControl

See Also:

Object.toString()