org.apache.directory.shared.ldap.codec.search
Class SearchResultDoneCodec

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec
          org.apache.directory.shared.ldap.codec.LdapResponseCodec
              org.apache.directory.shared.ldap.codec.search.SearchResultDoneCodec

All Implemented Interfaces:

Asn1Object

public class SearchResultDoneCodec
extends LdapResponseCodec

A SearchResultDone Message. Its syntax is : SearchResultDone ::= [APPLICATION 5] LDAPResult It's a Response, so it inherites from LdapResponse.

Version:

$Rev: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

SearchResultDoneCodec()
Creates a new SearchResultDone object.

Method Summary

int	computeLength() Compute the SearchResultDone length SearchResultDone : 0x65 L1 | +--> LdapResult L1 = Length(LdapResult) Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the SearchResultDone message to a PDU.
int	getMessageType() Get the message type
java.lang.String	toString() Get a String representation of a SearchResultDone

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapResponseCodec

getLdapResponseLength, getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getIntermediateResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultDoneCodec

public SearchResultDoneCodec()

Creates a new SearchResultDone object.

Method Detail

getMessageType

public int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

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 Asn1Object

Overrides:

computeLength in class LdapResponseCodec

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException

Encode the SearchResultDone message to a PDU.

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapResponseCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Get a String representation of a SearchResultDone

Overrides:

toString in class LdapResponseCodec

Returns:

A SearchResultDone String