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

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.search.SearchResultReference

public class SearchResultReference
extends LdapMessage

A SearchResultReference Message. Its syntax is : SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
SearchResultReference()
          Creates a new SearchResultEntry object.
 
Method Summary
 void addSearchResultReference(LdapURL searchResultReference)
          Add a new reference to the list.
 int computeLength()
          Compute the SearchResultReference length SearchResultReference : 0x73 L1 | +--> 0x04 L2 reference +--> 0x04 L3 reference +--> ...
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the SearchResultReference message to a PDU.
 int getMessageType()
          Get the message type
 java.util.ArrayList getSearchResultReferences()
          Get the list of references
 java.lang.String toString()
          Returns the Search Result Reference string
 
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

SearchResultReference

public SearchResultReference()
Creates a new SearchResultEntry object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessage
Returns:
Returns the type.

addSearchResultReference

public void addSearchResultReference(LdapURL searchResultReference)
Add a new reference to the list.

Parameters:
searchResultReference - The search result reference

getSearchResultReferences

public java.util.ArrayList getSearchResultReferences()
Get the list of references

Returns:
An ArrayList of SearchResultReferences

computeLength

public int computeLength()
Compute the SearchResultReference length SearchResultReference : 0x73 L1 | +--> 0x04 L2 reference +--> 0x04 L3 reference +--> ... +--> 0x04 Li reference +--> ... +--> 0x04 Ln reference L1 = n*Length(0x04) + sum(Length(Li)) + sum(Length(reference[i])) Length(SearchResultReference) = Length(0x73 + Length(L1) + L1

Overrides:
computeLength in class LdapMessage

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the SearchResultReference message to a PDU. SearchResultReference : 0x73 LL 0x04 LL reference [0x04 LL reference]*

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

toString

public java.lang.String toString()
Returns the Search Result Reference string

Overrides:
toString in class LdapMessage
Returns:
The Search Result Reference string


Copyright © 2003-2006 . All Rights Reserved.