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

java.lang.Object
  extended byorg.apache.directory.shared.asn1.Asn1Object
      extended byorg.apache.directory.shared.ldap.codec.LdapMessage
          extended byorg.apache.directory.shared.ldap.codec.LdapResponse
              extended byorg.apache.directory.shared.ldap.codec.search.SearchResultDone

public class SearchResultDone
extends LdapResponse

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

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
SearchResultDone()
          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.LdapResponse
getLdapResponseLength, getLdapResult, setLdapResult
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControl, setMessageId, setProtocolOP
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
addLength, getCurrentLength, getExpectedLength, getParent, setCurrentLength, setExpectedLength, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchResultDone

public SearchResultDone()
Creates a new SearchResultDone object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessage
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

Overrides:
computeLength in class LdapResponse

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the SearchResultDone message to a PDU.

Overrides:
encode in class LdapResponse
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
org.apache.directory.shared.asn1.codec.EncoderException

toString

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

Overrides:
toString in class LdapResponse
Returns:
A SearchResultDone String


Copyright © 2003-2006 . All Rights Reserved.