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

Class AdDirSyncRequestImpl

java.lang.Object

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

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

All Implemented Interfaces:

AdDirSyncRequest, org.apache.directory.api.ldap.model.message.Control

public class AdDirSyncRequestImpl
extends org.apache.directory.api.ldap.model.message.controls.AbstractControl
implements AdDirSyncRequest

The class implementing the AdDirsSync interface

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	cookie The DirSync cookie
private int	maxAttributeCount The maximum attribute count to return
private int	parentsFirst The parentsFirst value

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

OID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
byte[]	getCookie()
int	getMaxAttributeCount()
int	getParentsFirst()
int	hashCode()
void	setCookie(byte[] cookie)
void	setMaxAttributeCount(int maxAttributeCount)
void	setParentsFirst(int parentsFirst) Tell the server that it should send the parents of the children before their children.
String	toString()

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

parentsFirst

private int parentsFirst

The parentsFirst value

maxAttributeCount

private int maxAttributeCount

The maximum attribute count to return

cookie

private byte[] cookie

The DirSync cookie

Constructor Detail

AdDirSyncRequestImpl

public AdDirSyncRequestImpl()

Creates an instance of the DirSync control

Method Detail

getParentsFirst

public int getParentsFirst()

Specified by:

getParentsFirst in interface AdDirSyncRequest

Returns:

1 if the parents of the children comes before their children

setParentsFirst

public void setParentsFirst(int parentsFirst)

Tell the server that it should send the parents of the children before their children. NOTE: it should have been a boolean, it's an integer instead.

Specified by:

setParentsFirst in interface AdDirSyncRequest

Parameters:

parentsFirst - When set to 1, will return the parents before children

getMaxAttributeCount

public int getMaxAttributeCount()

Specified by:

getMaxAttributeCount in interface AdDirSyncRequest

Returns:

The maximum attribute count to be returned

setMaxAttributeCount

public void setMaxAttributeCount(int maxAttributeCount)

Specified by:

setMaxAttributeCount in interface AdDirSyncRequest

Parameters:

maxAttributeCount - The maximum attribute count to be returned

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface AdDirSyncRequest

Returns:

The cookie used while processing the successive DirSync operations

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface AdDirSyncRequest

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 org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Overrides:

equals in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.toString()