org.apache.directory.shared.dsmlv2.reponse
Class SearchResponseDsml

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.dsmlv2.LdapMessageDecorator
              extended by org.apache.directory.shared.dsmlv2.reponse.LdapResponseDecorator
                  extended by org.apache.directory.shared.dsmlv2.reponse.SearchResponseDsml
All Implemented Interfaces:
Asn1Object, DsmlDecorator

public class SearchResponseDsml
extends LdapResponseDecorator
implements DsmlDecorator

This class represents the Search Response Dsml Container. It is used to store Search Responses (Search Result Entry, Search Result Reference and SearchResultDone).

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
instance
 
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
SearchResponseDsml(LdapMessageCodec response)
          Creates a new instance of SearchResponseDsml.
 
Method Summary
 boolean addResponse(DsmlDecorator response)
          Adds a response.
 boolean removeResponse(DsmlDecorator response)
          Removes a response.
 org.dom4j.Element toDsml(org.dom4j.Element root)
          Converts the request/reponse to its XML representation in the DSMLv2 format
 
Methods inherited from class org.apache.directory.shared.dsmlv2.reponse.LdapResponseDecorator
getLdapResponseLength, getLdapResult, setLdapResult
 
Methods inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
addControl, addLength, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getCurrentLength, getDelRequest, getDelResponse, getExpectedLength, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageType, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getParent, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, setCurrentLength, setExpectedLength, setMessageId, setParent, toString
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControls, encode, getCodecControl, initControls, toString
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
getTlvId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchResponseDsml

public SearchResponseDsml(LdapMessageCodec response)
Creates a new instance of SearchResponseDsml.

Method Detail

addResponse

public boolean addResponse(DsmlDecorator response)
Adds a response.

Parameters:
response - the response to add
Returns:
true (as per the general contract of the Collection.add method).

removeResponse

public boolean removeResponse(DsmlDecorator response)
Removes a response.

Parameters:
response - the response to remove
Returns:
true if this list contained the specified element.

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)
Description copied from interface: DsmlDecorator
Converts the request/reponse to its XML representation in the DSMLv2 format

Specified by:
toDsml in interface DsmlDecorator
Parameters:
root - the root dom4j Element
Returns:
the dom4j Element corresponding to the entry.


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