org.apache.directory.shared.ldap.message

Class DeleteRequestImpl

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.AbstractAbandonableRequest

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

All Implemented Interfaces:

InternalAbandonableRequest, InternalDeleteRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, SingleReplyRequest

public class DeleteRequestImpl
extends AbstractAbandonableRequest
implements InternalDeleteRequest

Delete request implementation.

Version:

$Rev: 918756 $

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalDeleteRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks to see if an object is equivalent to this DeleteRequest.
DN	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.
InternalResultResponse	getResultResponse() The result containing response for this request.
void	setName(DN name) Sets the distinguished name of the leaf entry to be deleted by this request.
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.internal.InternalAbstractRequest

hashCode, hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalAbandonableRequest

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 DN getName()

Gets the distinguished name of the leaf entry to be deleted by this request.

Specified by:

getName in interface InternalDeleteRequest

Returns:

the DN of the leaf entry to delete.

setName

public void setName(DN name)

Sets the distinguished name of the leaf entry to be deleted by this request.

Specified by:

setName in interface InternalDeleteRequest

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 InternalResultResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Returns:

the result containing response for this request

equals

public boolean equals(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 InternalAbstractMessage

Parameters:

obj - the object to test for equality to this

Returns:

true if the obj is equal to this DeleteRequest, false otherwise

toString

public String toString()

Return a String representing a DelRequest

Overrides:

toString in class Object

Returns:

A DelRequest String