org.apache.directory.api.dsmlv2

Interface DsmlDecorator<M>

Type Parameters:

M - The message to decorate

All Known Implementing Classes:

AbandonRequestDsml, AbstractDsmlMessageDecorator, AbstractRequestDsml, AbstractResponseDsml, AbstractResultResponseDsml, AbstractResultResponseRequestDsml, AddRequestDsml, AddResponseDsml, BindRequestDsml, BindResponseDsml, CompareRequestDsml, CompareResponseDsml, DelRequestDsml, DelResponseDsml, DsmlControl, ErrorResponse, ExtendedRequestDsml, ExtendedResponseDsml, LdapResultDsml, ModDNResponseDsml, ModifyDNRequestDsml, ModifyRequestDsml, ModifyResponseDsml, SearchRequestDsml, SearchResponseDsml, SearchResultDoneDsml, SearchResultEntryDsml, SearchResultReferenceDsml

public interface DsmlDecorator<M>

This interface defines the methods that must be implemented to define a DSML Decorator

Method Summary

Modifier and Type	Method and Description
M	getDecorated() Gets the Message this DsmlDecorator decorates.
org.dom4j.Element	toDsml(org.dom4j.Element root) Converts the request/reponse to its XML representation in the DSMLv2 format

Method Detail

toDsml

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

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

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getDecorated

M getDecorated()

Gets the Message this DsmlDecorator decorates.

Returns:

The decorated Message instance