org.apache.directory.shared.ldap.codec.compare
Class CompareRequest

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessage
          extended by org.apache.directory.shared.ldap.codec.compare.CompareRequest
All Implemented Interfaces:
Asn1Object

public class CompareRequest
extends LdapMessage

A CompareRequest Message. Its syntax is : CompareRequest ::= [APPLICATION 14] SEQUENCE { entry LDAPDN, ava AttributeValueAssertion } AttributeValueAssertion ::= SEQUENCE { attributeDesc AttributeDescription, assertionValue AssertionValue } AttributeDescription ::= LDAPString AssertionValue ::= OCTET STRING

Version:
$Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sa, 07 Jun 2008) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
CompareRequest()
          Creates a new CompareRequest object.
 
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
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the CompareRequest message to a PDU.
 java.lang.Object getAssertionValue()
          Get the assertion value
 java.lang.String getAttributeDesc()
          Get the attribute description
 LdapDN getEntry()
          Get the entry to be compared
 int getMessageType()
          Get the message type
 void setAssertionValue(java.lang.Object assertionValue)
          Set the assertion value
 void setAttributeDesc(java.lang.String attributeDesc)
          Set the attribute description
 void setEntry(LdapDN entry)
          Set the entry to be compared
 java.lang.String toString()
          Get a String representation of a Compare Request
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompareRequest

public CompareRequest()
Creates a new CompareRequest object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessage
Returns:
Returns the type.

getEntry

public LdapDN getEntry()
Get the entry to be compared

Returns:
Returns the entry.

setEntry

public void setEntry(LdapDN entry)
Set the entry to be compared

Parameters:
entry - The entry to set.

getAssertionValue

public java.lang.Object getAssertionValue()
Get the assertion value

Returns:
Returns the assertionValue.

setAssertionValue

public void setAssertionValue(java.lang.Object assertionValue)
Set the assertion value

Parameters:
assertionValue - The assertionValue to set.

getAttributeDesc

public java.lang.String getAttributeDesc()
Get the attribute description

Returns:
Returns the attributeDesc.

setAttributeDesc

public void setAttributeDesc(java.lang.String attributeDesc)
Set the attribute description

Parameters:
attributeDesc - The attributeDesc to set.

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 Asn1Object
Overrides:
computeLength in class LdapMessage
Returns:
The CompareRequest PDU's length

encode

public java.nio.ByteBuffer encode(java.nio.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 Asn1Object
Overrides:
encode in class LdapMessage
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - If anything goes wrong.

toString

public java.lang.String toString()
Get a String representation of a Compare Request

Overrides:
toString in class LdapMessage
Returns:
A Compare Request String


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.