org.apache.directory.shared.ldap.codec.del
Class DelRequestCodec

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessageCodec
          extended by org.apache.directory.shared.ldap.codec.del.DelRequestCodec
All Implemented Interfaces:
Asn1Object

public class DelRequestCodec
extends LdapMessageCodec

A DelRequest Message. Its syntax is : DelRequest ::= [APPLICATION 10] LDAPDN

Version:
$Rev: 918756 $, $Date: 2010-03-04 00:05:29 +0100 (Thu, 04 Mar 2010) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
ldapMessageLength
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
DelRequestCodec()
          Creates a new DelRequest object.
 
Method Summary
protected  int computeLengthProtocolOp()
          Compute the DelRequest length DelRequest : 0x4A L1 entry L1 = Length(entry) Length(DelRequest) = Length(0x4A) + Length(L1) + L1
protected  void encodeProtocolOp(java.nio.ByteBuffer buffer)
          Encode the DelRequest message to a PDU.
 DN getEntry()
          Get the entry to be deleted
 MessageTypeEnum getMessageType()
          Get the message type
 java.lang.String getMessageTypeName()
          Get the message type Name
 void setEntry(DN entry)
          Set the entry to be deleted
 java.lang.String toString()
          Return a String representing a DelRequest
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
addLength, encode, 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

DelRequestCodec

public DelRequestCodec()
Creates a new DelRequest object.

Method Detail

getMessageType

public MessageTypeEnum getMessageType()
Get the message type

Specified by:
getMessageType in class LdapMessageCodec
Returns:
Returns the type.

getMessageTypeName

public java.lang.String getMessageTypeName()
Get the message type Name

Specified by:
getMessageTypeName in class LdapMessageCodec
Returns:
The message type name

getEntry

public DN getEntry()
Get the entry to be deleted

Returns:
Returns the entry.

setEntry

public void setEntry(DN entry)
Set the entry to be deleted

Parameters:
entry - The entry to set.

computeLengthProtocolOp

protected int computeLengthProtocolOp()
Compute the DelRequest length DelRequest : 0x4A L1 entry L1 = Length(entry) Length(DelRequest) = Length(0x4A) + Length(L1) + L1

Specified by:
computeLengthProtocolOp in class LdapMessageCodec

encodeProtocolOp

protected void encodeProtocolOp(java.nio.ByteBuffer buffer)
                         throws EncoderException
Encode the DelRequest message to a PDU. DelRequest : 0x4A LL entry

Specified by:
encodeProtocolOp in class LdapMessageCodec
Parameters:
buffer - The buffer where to put the PDU
Throws:
EncoderException

toString

public java.lang.String toString()
Return a String representing a DelRequest

Overrides:
toString in class java.lang.Object
Returns:
A DelRequest String


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