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

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.SearchResultReferenceDsml
All Implemented Interfaces:
Asn1Object, DsmlDecorator

public class SearchResultReferenceDsml
extends LdapResponseDecorator
implements DsmlDecorator

DSML Decorator for SearchResultReference

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
SearchResultReferenceDsml()
          Creates a new instance of SearchResultReferenceDsml.
SearchResultReferenceDsml(LdapMessageCodec ldapMessage)
          Creates a new instance of SearchResultReferenceDsml.
 
Method Summary
 void addSearchResultReference(LdapURL searchResultReference)
          Add a new reference to the list.
 MessageTypeEnum getMessageType()
          Get the message type
 java.util.List<LdapURL> getSearchResultReferences()
          Get the list of references
 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, 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

SearchResultReferenceDsml

public SearchResultReferenceDsml()
Creates a new instance of SearchResultReferenceDsml.


SearchResultReferenceDsml

public SearchResultReferenceDsml(LdapMessageCodec ldapMessage)
Creates a new instance of SearchResultReferenceDsml.

Parameters:
ldapMessage - the message to decorate
Method Detail

getMessageType

public MessageTypeEnum getMessageType()
Description copied from class: LdapMessageCodec
Get the message type

Overrides:
getMessageType in class LdapMessageDecorator
Returns:
The message type

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.

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


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