org.apache.directory.shared.dsmlv2.reponse

Class ExtendedResponseDsml

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.reponse.LdapResponseDecorator

org.apache.directory.shared.dsmlv2.reponse.ExtendedResponseDsml

All Implemented Interfaces:

Asn1Object, DsmlDecorator

public class ExtendedResponseDsml
extends LdapResponseDecorator
implements DsmlDecorator

DSML Decorator for ExtendedResponse

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
ExtendedResponseDsml() Creates a new instance of ExtendedResponseDsml.
ExtendedResponseDsml(ExtendedResponseCodec ldapMessage) Creates a new instance of ExtendedResponseDsml.

Method Summary

Modifier and Type	Method and Description
MessageTypeEnum	getMessageType() Get the message type
Object	getResponse() Get the extended response
String	getResponseName() Get the extended response name
void	setResponse(Object response) Set the extended response
void	setResponseName(OID responseName) Set the extended response name
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

ExtendedResponseDsml

public ExtendedResponseDsml()

Creates a new instance of ExtendedResponseDsml.

ExtendedResponseDsml

public ExtendedResponseDsml(ExtendedResponseCodec ldapMessage)

Creates a new instance of ExtendedResponseDsml.

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.

getResponseName

public String getResponseName()

Get the extended response name

Returns:

Returns the name.

setResponseName

public void setResponseName(OID responseName)

Set the extended response name

Parameters:

responseName - The name to set.

getResponse

public Object getResponse()

Get the extended response

Returns:

Returns the response.

setResponse

public void setResponse(Object response)

Set the extended response

Parameters:

response - The response to set.