org.apache.directory.shared.ldap.codec.decorators
Class SearchResultDoneDecorator

java.lang.Object
  org.apache.directory.shared.ldap.codec.decorators.MessageDecorator<M>
      org.apache.directory.shared.ldap.codec.decorators.ResponseDecorator<SearchResultDone>
          org.apache.directory.shared.ldap.codec.decorators.SearchResultDoneDecorator

All Implemented Interfaces:

Decorator<SearchResultDone>, Message, Response, ResultResponse, SearchResultDone

public class SearchResultDoneDecorator
extends ResponseDecorator<SearchResultDone>
implements SearchResultDone

A decorator for the SearchResultDone message

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.decorators.MessageDecorator

messageLength

Fields inherited from interface org.apache.directory.shared.ldap.model.message.SearchResultDone

TYPE

Constructor Summary

SearchResultDoneDecorator(LdapCodecService codec, SearchResultDone decoratedMessage)
Makes a SearchResultDone encodable.

Method Summary

int	computeLength() Compute the SearchResultDone length SearchResultDone :
ByteBuffer	encode(ByteBuffer buffer) Encode the SearchResultDone message to a PDU.
int	getSearchResultDoneLength()
void	setSearchResultDoneLength(int searchResultDoneLength) Stores the encoded length for the SearchResultDone

Methods inherited from class org.apache.directory.shared.ldap.codec.decorators.ResponseDecorator

getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.shared.ldap.codec.decorators.MessageDecorator

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, setMessageLength, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.model.message.ResultResponse

getLdapResult

Methods inherited from interface org.apache.directory.shared.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Constructor Detail

SearchResultDoneDecorator

public SearchResultDoneDecorator(LdapCodecService codec,
                                 SearchResultDone decoratedMessage)

Makes a SearchResultDone encodable.

Parameters:

decoratedMessage - the decorated SearchResultDone

Method Detail

setSearchResultDoneLength

public void setSearchResultDoneLength(int searchResultDoneLength)

Stores the encoded length for the SearchResultDone

Parameters:

searchResultDoneLength - The encoded length

getSearchResultDoneLength

public int getSearchResultDoneLength()

Returns:

The encoded SearchResultDone's length

computeLength

public int computeLength()

Compute the SearchResultDone length SearchResultDone :

 0x65 L1 
   | 
   +--> LdapResult 
   
 L1 = Length(LdapResult) 
 Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
 

Specified by:

computeLength in interface Decorator<SearchResultDone>

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the SearchResultDone message to a PDU.

Specified by:

encode in interface Decorator<SearchResultDone>

Parameters:

buffer - The buffer where to put the PDU

searchResultDoneDecorator - The SearchResultDone decorator

Returns:

The PDU.

Throws:

EncoderException - if the buffer can't be encoded