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

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

All Implemented Interfaces:

Asn1Object

public class SearchResultReferenceCodec
extends LdapMessageCodec

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

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

SearchResultReferenceCodec()
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.List<LdapURL>	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.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

SearchResultReferenceCodec

public SearchResultReferenceCodec()

Creates a new SearchResultEntry object.

Method Detail

getMessageType

public int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

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.List<LdapURL> 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

Specified by:

computeLength in interface Asn1Object

Overrides:

computeLength in class LdapMessageCodec

encode

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

Encode the SearchResultReference message to a PDU. SearchResultReference : 0x73 LL 0x04 LL reference [0x04 LL reference]*

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapMessageCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Returns the Search Result Reference string

Overrides:

toString in class LdapMessageCodec

Returns:

The Search Result Reference string