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

Class AdDirSyncDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<AdDirSync>

org.apache.directory.api.ldap.extras.controls.ad_impl.AdDirSyncDecorator

All Implemented Interfaces:

Asn1Object, CodecControl<AdDirSync>, Decorator<AdDirSync>, AdDirSync, Control

public class AdDirSyncDecorator
extends ControlDecorator<AdDirSync>
implements AdDirSync

A decorator around AdDirSync control. It will encode and decode this control.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.ControlDecorator

value, valueLength

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

OID

Constructor Summary

Constructors

Constructor and Description
AdDirSyncDecorator(LdapApiService codec) Creates a new instance of AdDirSyncControlCodec.
AdDirSyncDecorator(LdapApiService codec, AdDirSync control) Creates a new instance of AdDirSyncDecorator.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the AdDirSync length.
Asn1Object	decode(byte[] controlBytes) Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.
ByteBuffer	encode(ByteBuffer buffer) Encode the AdDirSync control.
byte[]	getCookie()
AdDirSyncFlag	getFlag()
int	getMaxReturnLength()
int	getParentFirst()
byte[]	getValue() Get the control value
void	setCookie(byte[] cookie)
void	setFlag(AdDirSyncFlag flag)
void	setMaxReturnLength(int maxReturnLength)
void	setParentFirst(int parentFirst)

Methods inherited from class org.apache.directory.api.ldap.codec.api.ControlDecorator

equals, getCodecService, getDecorated, getOid, hashCode, hasValue, isCritical, setCritical, setDecorated, setValue, toString

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

Constructor Detail

AdDirSyncDecorator

public AdDirSyncDecorator(LdapApiService codec)

Creates a new instance of AdDirSyncControlCodec.

AdDirSyncDecorator

public AdDirSyncDecorator(LdapApiService codec,
                          AdDirSync control)

Creates a new instance of AdDirSyncDecorator.

Parameters:

codec - The LDAP codec

control - The control to be decorated

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.

computeLength

public int computeLength()

Compute the AdDirSync length. We use the client side control. 0x30 L1 | +--> 0x02 0x0(1-4) nnn (parentFirst) +--> 0x02 0x0(1-4) nnn (maxReturnLength) +--> 0x04 L2 xkcd!!!... (cookie)

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in interface Decorator<AdDirSync>

Overrides:

computeLength in class ControlDecorator<AdDirSync>

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the AdDirSync control. We use the client side control.

Specified by:

encode in interface Asn1Object

Specified by:

encode in interface Decorator<AdDirSync>

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong while encoding.

getValue

public byte[] getValue()

Get the control value

Specified by:

getValue in interface CodecControl<AdDirSync>

Overrides:

getValue in class ControlDecorator<AdDirSync>

Returns:

The control value

decode

public Asn1Object decode(byte[] controlBytes)
                  throws DecoderException

Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.

Specified by:

decode in interface CodecControl<AdDirSync>

Parameters:

controlBytes - the encoded control bytes

Returns:

the decoded Asn1Object for the control

Throws:

DecoderException - if anything goes wrong