org.apache.directory.shared.ldap.codec.decorators
Class CompareRequestDecorator

java.lang.Object
  org.apache.directory.shared.ldap.codec.decorators.MessageDecorator<M>
      org.apache.directory.shared.ldap.codec.decorators.RequestDecorator<M>
          org.apache.directory.shared.ldap.codec.decorators.ResultResponseRequestDecorator<M>
              org.apache.directory.shared.ldap.codec.decorators.SingleReplyRequestDecorator<CompareRequest>
                  org.apache.directory.shared.ldap.codec.decorators.CompareRequestDecorator

All Implemented Interfaces:

Decorator<CompareRequest>, AbandonableRequest, CompareRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class CompareRequestDecorator
extends SingleReplyRequestDecorator<CompareRequest>
implements CompareRequest

A decorator for the CompareRequest message

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.decorators.MessageDecorator

messageLength

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

RESP_TYPE, TYPE

Constructor Summary

CompareRequestDecorator(LdapCodecService codec, CompareRequest decoratedMessage)
Makes a CompareRequest a MessageDecorator.

Method Summary

int	computeLength() Compute the CompareRequest length CompareRequest : 0x6E L1 | +--> 0x04 L2 entry +--> 0x30 L3 (ava) | +--> 0x04 L4 attributeDesc +--> 0x04 L5 assertionValue L3 = Length(0x04) + Length(L4) + L4 + Length(0x04) + Length(L5) + L5 Length(CompareRequest) = Length(0x6E) + Length(L1) + L1 + Length(0x04) + Length(L2) + L2 + Length(0x30) + Length(L3) + L3
ByteBuffer	encode(ByteBuffer buffer) Encode the CompareRequest message to a PDU.
Value<?>	getAssertionValue()
String	getAttributeId()
byte[]	getAttrIdBytes() Gets the attribute id bytes use in making the comparison.
byte[]	getAttrValBytes() Gets the attribute value bytes use in making the comparison.
int	getAvaLength()
int	getCompareRequestLength()
Dn	getName()
void	setAssertionValue(byte[] value)
void	setAssertionValue(String value)
void	setAttributeId(String attrId)
void	setAttrIdBytes(byte[] attrIdBytes) Sets the attribute id bytes used in the comparison.
void	setAttrValBytes(byte[] attrValBytes) Sets the attribute value bytes used in the comparison.
void	setAvaLength(int avaLength) Stores the encoded length for the ava
void	setCompareRequestLength(int compareRequestLength) Stores the encoded length for the CompareRequest
void	setName(Dn name)

Methods inherited from class org.apache.directory.shared.ldap.codec.decorators.SingleReplyRequestDecorator

abandon, addAbandonListener, getResponseType, isAbandoned

Methods inherited from class org.apache.directory.shared.ldap.codec.decorators.ResultResponseRequestDecorator

getResultResponse, hasResponse

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

getResponseType

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

getResultResponse

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

hasResponse

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

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

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

abandon, addAbandonListener, isAbandoned

Constructor Detail

CompareRequestDecorator

public CompareRequestDecorator(LdapCodecService codec,
                               CompareRequest decoratedMessage)

Makes a CompareRequest a MessageDecorator.

Parameters:

decoratedMessage - the decorated CompareRequest

Method Detail

setCompareRequestLength

public void setCompareRequestLength(int compareRequestLength)

Stores the encoded length for the CompareRequest

Parameters:

compareRequestLength - The encoded length

getCompareRequestLength

public int getCompareRequestLength()

Returns:

The encoded CompareRequest length

setAvaLength

public void setAvaLength(int avaLength)

Stores the encoded length for the ava

Parameters:

avaLength - The encoded length

getAvaLength

public int getAvaLength()

Returns:

The encoded ava length

getAttrIdBytes

public byte[] getAttrIdBytes()

Gets the attribute id bytes use in making the comparison.

Returns:

the attribute id bytes used in comparison.

setAttrIdBytes

public void setAttrIdBytes(byte[] attrIdBytes)

Sets the attribute id bytes used in the comparison.

Parameters:

attrIdBytes - the attribute id bytes used in comparison.

getAttrValBytes

public byte[] getAttrValBytes()

Gets the attribute value bytes use in making the comparison.

Returns:

the attribute value bytes used in comparison.

setAttrValBytes

public void setAttrValBytes(byte[] attrValBytes)

Sets the attribute value bytes used in the comparison.

Parameters:

attrValBytes - the attribute value bytes used in comparison.

getName

public Dn getName()

Specified by:

getName in interface CompareRequest

setName

public void setName(Dn name)

Specified by:

setName in interface CompareRequest

getAssertionValue

public Value<?> getAssertionValue()

Specified by:

getAssertionValue in interface CompareRequest

setAssertionValue

public void setAssertionValue(String value)

Specified by:

setAssertionValue in interface CompareRequest

setAssertionValue

public void setAssertionValue(byte[] value)

Specified by:

setAssertionValue in interface CompareRequest

getAttributeId

public String getAttributeId()

Specified by:

getAttributeId in interface CompareRequest

setAttributeId

public void setAttributeId(String attrId)

Specified by:

setAttributeId in interface CompareRequest

computeLength

public int computeLength()

Compute the CompareRequest length CompareRequest : 0x6E L1 | +--> 0x04 L2 entry +--> 0x30 L3 (ava) | +--> 0x04 L4 attributeDesc +--> 0x04 L5 assertionValue L3 = Length(0x04) + Length(L4) + L4 + Length(0x04) + Length(L5) + L5 Length(CompareRequest) = Length(0x6E) + Length(L1) + L1 + Length(0x04) + Length(L2) + L2 + Length(0x30) + Length(L3) + L3

Specified by:

computeLength in interface Decorator<CompareRequest>

Returns:

The CompareRequest PDU's length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the CompareRequest message to a PDU. CompareRequest : 0x6E LL 0x04 LL entry 0x30 LL attributeValueAssertion 0x04 LL attributeDesc 0x04 LL assertionValue

Specified by:

encode in interface Decorator<CompareRequest>

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - if the buffer can't be encoded