org.apache.directory.api.ldap.model.message
Interface DeleteRequest

All Superinterfaces:

AbandonableRequest, Message, Request, ResultResponseRequest<DeleteResponse>, SingleReplyRequest<DeleteResponse>

All Known Implementing Classes:

DeleteRequestImpl

public interface DeleteRequest
extends SingleReplyRequest<DeleteResponse>, AbandonableRequest

Delete request protocol message used to remove an existing leaf entry from the directory.

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum	RESP_TYPE Delete response message type enumeration value
static MessageTypeEnum	TYPE Delete request message type enumeration value

Method Summary

DeleteRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
DeleteRequest	addControl(Control control) Adds a control to this Message.
Dn	getName() Gets the distinguished name of the leaf entry to be deleted by this request.
DeleteRequest	removeControl(Control control) Deletes a control removing it from this Message.
DeleteRequest	setMessageId(int messageId) Sets the Message ID for this request
DeleteRequest	setName(Dn name) Sets the distinguished name of the leaf entry to be deleted by this request.

Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest

getResponseType

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

getResultResponse

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

hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put

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

abandon, addAbandonListener, isAbandoned

Field Detail

TYPE

static final MessageTypeEnum TYPE

Delete request message type enumeration value

RESP_TYPE

static final MessageTypeEnum RESP_TYPE

Delete response message type enumeration value

Method Detail

getName

Dn getName()

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

Returns:

the Dn of the leaf entry to delete.

setName

DeleteRequest setName(Dn name)

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

Parameters:

name - the Dn of the leaf entry to delete.

Returns:

The DeleteRequest instance

setMessageId

DeleteRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface Message

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

DeleteRequest addControl(Control control)
                         throws MessageException

Adds a control to this Message.

Specified by:

addControl in interface Message

Parameters:

control - the control to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

addAllControls

DeleteRequest addAllControls(Control[] controls)
                             throws MessageException

Adds an array of controls to this Message.

Specified by:

addAllControls in interface Message

Parameters:

controls - the controls to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or they are not known etc.

removeControl

DeleteRequest removeControl(Control control)
                            throws MessageException

Deletes a control removing it from this Message.

Specified by:

removeControl in interface Message

Parameters:

control - the control to remove.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.