org.apache.directory.shared.dsmlv2.reponse

Class CompareResponseDsml

java.lang.Object

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

org.apache.directory.shared.dsmlv2.reponse.AbstractResponseDsml<E>

org.apache.directory.shared.dsmlv2.reponse.AbstractResultResponseDsml<CompareResponse>

org.apache.directory.shared.dsmlv2.reponse.CompareResponseDsml

All Implemented Interfaces:

DsmlDecorator<CompareResponse>, CompareResponse, Message, Response, ResultResponse

public class CompareResponseDsml
extends AbstractResultResponseDsml<CompareResponse>
implements CompareResponse

DSML Decorator for CompareResponse

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.shared.ldap.model.message.CompareResponse

TYPE

Constructor Summary

Constructors

Constructor and Description
CompareResponseDsml(LdapApiService codec) Creates a new getDecoratedMessage() of CompareResponseDsml.
CompareResponseDsml(LdapApiService codec, CompareResponse ldapMessage) Creates a new getDecoratedMessage() of CompareResponseDsml.

Method Summary

Methods

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

getLdapResult

Methods inherited from class org.apache.directory.shared.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.shared.ldap.model.message.ResultResponse

getLdapResult

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

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

Constructor Detail

CompareResponseDsml

public CompareResponseDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of CompareResponseDsml.

CompareResponseDsml

public CompareResponseDsml(LdapApiService codec,
                   CompareResponse ldapMessage)

Creates a new getDecoratedMessage() of CompareResponseDsml.

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

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

Specified by:

toDsml in class AbstractResultResponseDsml<CompareResponse>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

isTrue

public boolean isTrue()

Specified by:

isTrue in interface CompareResponse

Returns:

True if the compared response is a success