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

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessageCodec
          extended by org.apache.directory.shared.ldap.codec.LdapResponseCodec
              extended by 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: 912399 $, $Date: 2010-02-21 21:52:31 +0100 (Sun, 21 Feb 2010) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
ldapMessageLength
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
SearchResultDoneCodec()
          Creates a new SearchResultDone object.
 
Method Summary
protected  int computeLengthProtocolOp()
          Compute the SearchResultDone length SearchResultDone :
protected  void encodeProtocolOp(java.nio.ByteBuffer buffer)
          Encode the SearchResultDone message to a PDU.
 MessageTypeEnum getMessageType()
          Get the message type
 java.lang.String getMessageTypeName()
          Get the message type Name
 java.lang.String toString()
          Get a String representation of a SearchResultDone
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapResponseCodec
computeLdapResultLength, encode, getLdapResponseLength, getLdapResult, setLdapResult
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString
 
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 MessageTypeEnum getMessageType()
Get the message type

Specified by:
getMessageType in class LdapMessageCodec
Returns:
Returns the type.

getMessageTypeName

public java.lang.String getMessageTypeName()
Get the message type Name

Specified by:
getMessageTypeName in class LdapMessageCodec
Returns:
The message type name

computeLengthProtocolOp

protected int computeLengthProtocolOp()
Compute the SearchResultDone length SearchResultDone :
 0x65 L1 
   | 
   +--> LdapResult 
   
 L1 = Length(LdapResult) 
 Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
 

Specified by:
computeLengthProtocolOp in class LdapMessageCodec

encodeProtocolOp

protected void encodeProtocolOp(java.nio.ByteBuffer buffer)
                         throws EncoderException
Encode the SearchResultDone message to a PDU.

Specified by:
encodeProtocolOp in class LdapMessageCodec
Parameters:
buffer - The buffer where to put the PDU
Throws:
EncoderException

toString

public java.lang.String toString()
Get a String representation of a SearchResultDone

Overrides:
toString in class LdapResponseCodec
Returns:
A SearchResultDone String


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.