org.apache.directory.api.ldap.codec.decorators

Class CompareResponseDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResponseDecorator<CompareResponse>

org.apache.directory.api.ldap.codec.decorators.CompareResponseDecorator

All Implemented Interfaces:

Asn1Object, Decorator<CompareResponse>, CompareResponse, Message, Response, ResultResponse

public class CompareResponseDecorator
extends ResponseDecorator<CompareResponse>
implements CompareResponse

A decorator for the CompareResponse message

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

Constructor Summary

Constructors

Constructor and Description
CompareResponseDecorator(LdapApiService codec, CompareResponse decoratedMessage) Makes a CompareResponse a MessageDecorator.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the CompareResponse length CompareResponse : 0x6F L1 | +--> LdapResult L1 = Length(LdapResult) Length(CompareResponse) = Length(0x6F) + Length(L1) + L1
ByteBuffer	encode(ByteBuffer buffer) Encode the CompareResponse message to a PDU.
boolean	isTrue()

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResponseDecorator

getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, setMessageLength, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareResponseDecorator

public CompareResponseDecorator(LdapApiService codec,
                                CompareResponse decoratedMessage)

Makes a CompareResponse a MessageDecorator.

Parameters:

decoratedMessage - the decorated CompareResponse

Method Detail

isTrue

public boolean isTrue()

Specified by:

isTrue in interface CompareResponse

Returns:

True if the compared response is a success

computeLength

public int computeLength()

Compute the CompareResponse length CompareResponse : 0x6F L1 | +--> LdapResult L1 = Length(LdapResult) Length(CompareResponse) = Length(0x6F) + Length(L1) + L1

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in interface Decorator<CompareResponse>

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the CompareResponse message to a PDU.

Specified by:

encode in interface Asn1Object

Specified by:

encode in interface Decorator<CompareResponse>

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - if the buffer can't be encoded