org.apache.directory.api.dsmlv2.response

Class AbstractResultResponseDsml<E extends ResultResponse>

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<E>

All Implemented Interfaces:

DsmlDecorator<E>, Message, Response, ResultResponse

Direct Known Subclasses:

AddResponseDsml, BindResponseDsml, CompareResponseDsml, DelResponseDsml, ExtendedResponseDsml, ModDNResponseDsml, ModifyResponseDsml, SearchResultDoneDsml

public abstract class AbstractResultResponseDsml<E extends ResultResponse>
extends AbstractResponseDsml<E>
implements ResultResponse

Base class for all DSML responses.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
AbstractResultResponseDsml(LdapApiService codec, E resultResponse) Instantiates a new abstract DSML response.

Method Summary

Methods

Modifier and Type	Method and Description
LdapResult	getLdapResult() Gets the LdapResult components of this Response.
abstract 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.AbstractDsmlMessageDecorator

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

Methods inherited from class java.lang.Object

clone, equals, finalize, 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, getType, hasControl, put, removeControl, setMessageId

Constructor Detail

AbstractResultResponseDsml

public AbstractResultResponseDsml(LdapApiService codec,
                          E resultResponse)

Instantiates a new abstract DSML response.

Parameters:

ldapMessage - the LDAP message to decorate

Method Detail

toDsml

public abstract 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<E extends ResultResponse>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getLdapResult

public LdapResult getLdapResult()

Gets the LdapResult components of this Response.

Specified by:

getLdapResult in interface ResultResponse

Returns:

the LdapResult for this Response.