Package org.apache.directory.api.ldap.extras.controls.vlv_impl

Class VirtualListViewResponseDecorator

java.lang.Object

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

org.apache.directory.api.ldap.extras.controls.vlv_impl.VirtualListViewResponseDecorator

All Implemented Interfaces:

Asn1Object, CodecControl<VirtualListViewResponse>, Decorator<VirtualListViewResponse>, VirtualListViewResponse, Control

public class VirtualListViewResponseDecorator
extends ControlDecorator<VirtualListViewResponse>
implements VirtualListViewResponse

The VirtualListView response decorator

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponse

OID

Constructor Summary

Constructors

Constructor	Description
VirtualListViewResponseDecorator(LdapApiService codec)	Create a new SyncRequestValueDecorator instance
VirtualListViewResponseDecorator(LdapApiService codec, VirtualListViewResponse vlvRequest)	Create a new SyncRequestValueDecorator instance

Method Summary

Modifier and Type	Method	Description
int	computeLength()	Compute the object length, which is the sum of all inner length.
Asn1Object	decode(byte[] controlBytes)	Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.
ByteBuffer	encode(ByteBuffer buffer)	Encode the object to a PDU.
int	getContentCount()
byte[]	getContextId()
int	getTargetPosition()
byte[]	getValue()	Get the control value
VirtualListViewResultCode	getVirtualListViewResult()
void	setContentCount(int contentCount)	Sets the number of returned entries
void	setContextId(byte[] contextId)	Sets the context ID
void	setTargetPosition(int targetPosition)	Sets the position in the list of entries
void	setVirtualListViewResult(VirtualListViewResultCode virtualListViewResult)	Store the VLV result

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

getClass, notify, notifyAll, wait, wait, wait

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

getOid, isCritical, setCritical

Constructor Detail

VirtualListViewResponseDecorator

public VirtualListViewResponseDecorator(LdapApiService codec)

Create a new SyncRequestValueDecorator instance

Parameters:

codec - The LDAP API service to use

VirtualListViewResponseDecorator

public VirtualListViewResponseDecorator(LdapApiService codec,
                                        VirtualListViewResponse vlvRequest)

Create a new SyncRequestValueDecorator instance

Parameters:

codec - The LDAP API service to use

vlvRequest - The decorated VLV request

Method Detail

computeLength

public int computeLength()

Compute the object length, which is the sum of all inner length.

Specified by:

computeLength in interface Asn1Object

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the object to a PDU.

Specified by:

encode in interface Asn1Object

Parameters:

buffer - The buffer where to put the PDU

Returns:

The encoded PDU.

Throws:

EncoderException - if the buffer can't be encoded

getValue

public byte[] getValue()

Get the control value

Specified by:

getValue in interface CodecControl<VirtualListViewResponse>

Overrides:

getValue in class ControlDecorator<VirtualListViewResponse>

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<VirtualListViewResponse>

Parameters:

controlBytes - the encoded control bytes

Returns:

the decoded Asn1Object for the control

Throws:

DecoderException - if anything goes wrong

getTargetPosition

public int getTargetPosition()

Specified by:

getTargetPosition in interface VirtualListViewResponse

Returns:

the position in the list of entries

setTargetPosition

public void setTargetPosition(int targetPosition)

Sets the position in the list of entries

Specified by:

setTargetPosition in interface VirtualListViewResponse

Parameters:

targetPosition - the position in the list of entries

getContentCount

public int getContentCount()

Specified by:

getContentCount in interface VirtualListViewResponse

Returns:

The number of returned entries

setContentCount

public void setContentCount(int contentCount)

Sets the number of returned entries

Specified by:

setContentCount in interface VirtualListViewResponse

Parameters:

contentCount - The number of returned entries

getVirtualListViewResult

public VirtualListViewResultCode getVirtualListViewResult()

Specified by:

getVirtualListViewResult in interface VirtualListViewResponse

Returns:

The VLV result

setVirtualListViewResult

public void setVirtualListViewResult(VirtualListViewResultCode virtualListViewResult)

Store the VLV result

Specified by:

setVirtualListViewResult in interface VirtualListViewResponse

Parameters:

virtualListViewResult - The result

getContextId

public byte[] getContextId()

Specified by:

getContextId in interface VirtualListViewResponse

Returns:

The context ID

setContextId

public void setContextId(byte[] contextId)

Sets the context ID

Specified by:

setContextId in interface VirtualListViewResponse

Parameters:

contextId - The context ID