Package org.apache.directory.api.dsmlv2.response

Class ExtendedResponseDsml

java.lang.Object

org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>

org.apache.directory.api.dsmlv2.response.AbstractResponseDsml<E>

org.apache.directory.api.dsmlv2.response.AbstractResultResponseDsml<ExtendedResponse>

org.apache.directory.api.dsmlv2.response.ExtendedResponseDsml

All Implemented Interfaces:

DsmlDecorator<ExtendedResponse>, ExtendedResponse, Message, Response, ResultResponse

public class ExtendedResponseDsml
extends AbstractResultResponseDsml<ExtendedResponse>
implements ExtendedResponse

DSML Decorator for ExtendedResponse

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
ExtendedResponseDsml(LdapApiService codec)	Creates a new getDecoratedMessage() of ExtendedResponseDsml.
ExtendedResponseDsml(LdapApiService codec, ExtendedResponse ldapMessage)	Creates a new getDecoratedMessage() of ExtendedResponseDsml.

Method Summary

Modifier and Type	Method	Description
String	getResponseName()	Get the extended response name
byte[]	getResponseValue()	Get the extended response
MessageTypeEnum	getType()	Gets the LDAP message type code associated with this Message.
void	setResponseName(String oid)	Sets the OID uniquely identifying this extended response (a.k.a. its name).
void	setResponseName(Oid responseName)	Set the extended response name
void	setResponseValue(byte[] responseValue)	Set the extended 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.api.dsmlv2.response.AbstractResultResponseDsml

getLdapResult

Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator

addAllControls, addControl, get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put, removeControl, setMessageId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, hasControl, put, removeControl, setMessageId

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponse

getLdapResult

Constructor Detail

ExtendedResponseDsml

public ExtendedResponseDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of ExtendedResponseDsml.

Parameters:

codec - The LDAP Service to use

ExtendedResponseDsml

public ExtendedResponseDsml(LdapApiService codec,
                            ExtendedResponse ldapMessage)

Creates a new getDecoratedMessage() of ExtendedResponseDsml.

Parameters:

codec - The LDAP Service to use

ldapMessage - the message to decorate

Method Detail

getType

public MessageTypeEnum getType()

Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.

Specified by:

getType in interface Message

Overrides:

getType in class AbstractDsmlMessageDecorator<ExtendedResponse>

Returns:

the message type code.

toDsml

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

Converts the request/reponse to its XML representation in the DSMLv2 format

Specified by:

toDsml in interface DsmlDecorator<ExtendedResponse>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

setResponseName

public void setResponseName(String oid)

Sets the OID uniquely identifying this extended response (a.k.a. its name).

Specified by:

setResponseName in interface ExtendedResponse

Parameters:

oid - the OID of the extended response type.

getResponseName

public String getResponseName()

Get the extended response name

Specified by:

getResponseName in interface ExtendedResponse

Returns:

Returns the name.

setResponseName

public void setResponseName(Oid responseName)

Set the extended response name

Parameters:

responseName - The name to set.

getResponseValue

public byte[] getResponseValue()

Get the extended response

Returns:

Returns the response.

setResponseValue

public void setResponseValue(byte[] responseValue)

Set the extended response

Parameters:

responseValue - The response to set.