org.apache.directory.shared.dsmlv2.request
Class SearchRequestDsml

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec
          org.apache.directory.shared.dsmlv2.LdapMessageDecorator
              org.apache.directory.shared.dsmlv2.request.LdapRequestDecorator
                  org.apache.directory.shared.dsmlv2.request.AbstractRequestDsml
                      org.apache.directory.shared.dsmlv2.request.SearchRequestDsml

All Implemented Interfaces:

Asn1Object, DsmlDecorator

public class SearchRequestDsml
extends AbstractRequestDsml

DSML Decorator for SearchRequest

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

SearchRequestDsml()
Creates a new instance of SearchRequestDsml.

SearchRequestDsml(SearchRequestCodec ldapMessage)
Creates a new instance of SearchRequestDsml.

Method Summary

MessageTypeEnum	getMessageType()
org.dom4j.Element	toDsml(org.dom4j.Element root) Creates the Request Element and adds RequestID and Controls.

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

SearchRequestDsml

public SearchRequestDsml()

Creates a new instance of SearchRequestDsml.

SearchRequestDsml

public SearchRequestDsml(SearchRequestCodec ldapMessage)

Creates a new instance of SearchRequestDsml.

Parameters:

ldapMessage - the message to decorate

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Overrides:

getMessageType in class LdapMessageDecorator

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)

Creates the Request Element and adds RequestID and Controls.

Specified by:

toDsml in interface DsmlDecorator

Overrides:

toDsml in class AbstractRequestDsml

Parameters:

root - the root element

Returns:

the Request Element of the given name containing