org.apache.directory.shared.ldap.message
Class DeleteRequestImpl

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.AbstractMessage
      extended byorg.apache.directory.shared.ldap.message.AbstractRequest
          extended byorg.apache.directory.shared.ldap.message.AbstractAbandonableRequest
              extended byorg.apache.directory.shared.ldap.message.DeleteRequestImpl
All Implemented Interfaces:
AbandonableRequest, DeleteRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class DeleteRequestImpl
extends AbstractAbandonableRequest
implements DeleteRequest

Delete request implementation.

Version:
$Rev: 379008 $
Author:
Apache Directory Project

Field Summary
 
Fields inherited from interface org.apache.directory.shared.ldap.message.DeleteRequest
RESP_TYPE, TYPE
 
Constructor Summary
DeleteRequestImpl(int id)
          Creates a Lockable DeleteRequest implementing object used to delete a leaf entry from the DIT.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Checks to see if an object is equivalent to this DeleteRequest.
 java.lang.String getName()
          Gets the distinguished name of the leaf entry to be deleted by this request.
 MessageTypeEnum getResponseType()
          Gets the protocol response message type for this request which produces at least one response.
 ResultResponse getResultResponse()
          The result containing response for this request.
 void setName(java.lang.String name)
          Sets the distinguished name of the leaf entry to be deleted by this request.
 java.lang.String toString()
          Return a String representing a DelRequest
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
abandon, addAbandonListener, isAbandoned
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractRequest
hasResponse
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage
add, get, getControls, getMessageId, getType, put, remove
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Request
hasResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Message
add, get, getControls, getMessageId, getType, put, remove
 
Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
 

Constructor Detail

DeleteRequestImpl

public DeleteRequestImpl(int id)
Creates a Lockable DeleteRequest implementing object used to delete a leaf entry from the DIT.

Parameters:
id - the sequential message identifier
Method Detail

getName

public java.lang.String getName()
Gets the distinguished name of the leaf entry to be deleted by this request.

Specified by:
getName in interface DeleteRequest
Returns:
the DN of the leaf entry to delete.

setName

public void setName(java.lang.String name)
Sets the distinguished name of the leaf entry to be deleted by this request.

Specified by:
setName in interface DeleteRequest
Parameters:
name - the DN of the leaf entry to delete.

getResponseType

public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.

Specified by:
getResponseType in interface SingleReplyRequest
Returns:
the message type of the response.

getResultResponse

public ResultResponse getResultResponse()
The result containing response for this request.

Specified by:
getResultResponse in interface ResultResponseRequest
Returns:
the result containing response for this request

equals

public boolean equals(java.lang.Object obj)
Checks to see if an object is equivalent to this DeleteRequest. First there's a quick test to see if the obj is the same object as this one - if so true is returned. Next if the super method fails false is returned. Then the name of the entry is compared - if not the same false is returned. Finally the method exists returning true.

Overrides:
equals in class AbstractMessage
Parameters:
obj - the object to test for equality to this
Returns:
true if the obj is equal to this DeleteRequest, false otherwise

toString

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

Returns:
A DelRequest String


Copyright © 2003-2006 . All Rights Reserved.