org.apache.directory.api.dsmlv2.response

Class AddResponseDsml

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

org.apache.directory.api.dsmlv2.response.AddResponseDsml

All Implemented Interfaces:

DsmlDecorator<AddResponse>, AddResponse, Message, Response, ResultResponse

public class AddResponseDsml
extends AbstractResultResponseDsml<AddResponse>
implements AddResponse

DSML Decorator for AddResponse

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ADD_RESPONSE_TAG

Constructor Summary

Constructors

Constructor and Description
AddResponseDsml(LdapApiService codec) Creates a new getDecoratedMessage() of AddResponseDsml.
AddResponseDsml(LdapApiService codec, AddResponse ldapMessage) Creates a new getDecoratedMessage() of AddResponseDsml.

Method Summary

Modifier and Type	Method and Description
MessageTypeEnum	getType() Gets the LDAP message type code associated with this Message.
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

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

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

getLdapResult

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

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

Field Detail

ADD_RESPONSE_TAG

private static final java.lang.String ADD_RESPONSE_TAG

See Also:

Constant Field Values

Constructor Detail

AddResponseDsml

public AddResponseDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of AddResponseDsml.

AddResponseDsml

public AddResponseDsml(LdapApiService codec,
                       AddResponse ldapMessage)

Creates a new getDecoratedMessage() of AddResponseDsml.

Parameters:

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

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

Specified by:

toDsml in class AbstractResultResponseDsml<AddResponse>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.