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

Class AdDirSyncDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>

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

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>, org.apache.directory.api.ldap.extras.controls.ad.AdDirSync, org.apache.directory.api.ldap.model.message.Control

public class AdDirSyncDecorator
extends org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>
implements org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

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

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private int	adDirSyncLength The global length for this control
private static org.apache.directory.api.asn1.ber.Asn1Decoder	DECODER An instance of this decoder

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(org.apache.directory.api.ldap.codec.api.LdapApiService codec) Creates a new instance of AdDirSyncControlCodec.
AdDirSyncDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.ad.AdDirSync control) Creates a new instance of AdDirSyncDecorator.

Method Summary

Modifier and Type	Method and Description
void	addFlag(org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag flag)
int	computeLength() Compute the AdDirSync length.
org.apache.directory.api.asn1.Asn1Object	decode(byte[] controlBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the AdDirSync control.
byte[]	getCookie()
Set<org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag>	getFlags()
int	getMaxReturnLength()
byte[]	getValue()
void	removeFlag(org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag flag)
void	setCookie(byte[] cookie)
void	setFlags(Set<org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag> flags)
void	setMaxReturnLength(int maxReturnLength)

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

Field Detail

adDirSyncLength

private int adDirSyncLength

The global length for this control

DECODER

private static final org.apache.directory.api.asn1.ber.Asn1Decoder DECODER

An instance of this decoder

Constructor Detail

AdDirSyncDecorator

public AdDirSyncDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec)

Creates a new instance of AdDirSyncControlCodec.

Parameters:

codec - The LDAP Service to use

AdDirSyncDecorator

public AdDirSyncDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                          org.apache.directory.api.ldap.extras.controls.ad.AdDirSync control)

Creates a new instance of AdDirSyncDecorator.

Parameters:

codec - The LDAP Service to use

control - The control to be decorated

Method Detail

getFlags

public Set<org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag> getFlags()

Specified by:

getFlags in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

setFlags

public void setFlags(Set<org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag> flags)

Specified by:

setFlags in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

addFlag

public void addFlag(org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag flag)

Specified by:

addFlag in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

removeFlag

public void removeFlag(org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFlag flag)

Specified by:

removeFlag in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

getMaxReturnLength

public int getMaxReturnLength()

Specified by:

getMaxReturnLength in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

setMaxReturnLength

public void setMaxReturnLength(int maxReturnLength)

Specified by:

setMaxReturnLength in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface org.apache.directory.api.ldap.extras.controls.ad.AdDirSync

computeLength

public int computeLength()

Compute the AdDirSync length. We use the client side control.

 0x30 L1
 |
 +--> 0x02 0x0(1-4) nnn  (flags)
 +--> 0x02 0x0(1-4) nnn  (maxReturnLength)
 +--> 0x04 L2 xkcd!!!...     (cookie)
 

Specified by:

computeLength in interface org.apache.directory.api.asn1.Asn1Object

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws org.apache.directory.api.asn1.EncoderException

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

Specified by:

encode in interface org.apache.directory.api.asn1.Asn1Object

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.api.asn1.EncoderException - If anything goes wrong while encoding.

getValue

public byte[] getValue()

Specified by:

getValue in interface org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>

Overrides:

getValue in class org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>

decode

public org.apache.directory.api.asn1.Asn1Object decode(byte[] controlBytes)
                                                throws org.apache.directory.api.asn1.DecoderException

Specified by:

decode in interface org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.ad.AdDirSync>

Throws:

org.apache.directory.api.asn1.DecoderException