org.apache.directory.shared.dsmlv2.request

Class ExtendedRequestDsml

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.ExtendedRequestDsml

All Implemented Interfaces:

Asn1Object, DsmlDecorator

public class ExtendedRequestDsml
extends AbstractRequestDsml

DSML Decorator for ExtendedRequest

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

Constructors

Constructor and Description
ExtendedRequestDsml() Creates a new instance of ExtendedRequestDsml.
ExtendedRequestDsml(ExtendedRequestCodec ldapMessage) Creates a new instance of ExtendedRequestDsml.

Method Summary

Modifier and Type	Method and Description
MessageTypeEnum	getMessageType() Get the message type
String	getRequestName() Get the extended request name
byte[]	getRequestValue() Get the extended request value
void	setRequestName(OID requestName) Set the extended request name
void	setRequestValue(byte[] requestValue) Set the extended request value
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

ExtendedRequestDsml

public ExtendedRequestDsml()

Creates a new instance of ExtendedRequestDsml.

ExtendedRequestDsml

public ExtendedRequestDsml(ExtendedRequestCodec ldapMessage)

Creates a new instance of ExtendedRequestDsml.

Parameters:

ldapMessage - the message to decorate

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageDecorator

Returns:

The message type

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

getRequestName

public String getRequestName()

Get the extended request name

Returns:

Returns the request name.

setRequestName

public void setRequestName(OID requestName)

Set the extended request name

Parameters:

requestName - The request name to set.

getRequestValue

public byte[] getRequestValue()

Get the extended request value

Returns:

Returns the request value.

setRequestValue

public void setRequestValue(byte[] requestValue)

Set the extended request value

Parameters:

requestValue - The request value to set.