org.apache.directory.shared.ldap.model.message
Interface AbandonRequest

All Superinterfaces:

Message, Request

All Known Implementing Classes:

AbandonRequestImpl

public interface AbandonRequest
extends Request

Abandon protocol operation request to terminate an operation already in progress.

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum

TYPE Ldap abandon request type code

Method Summary

AbandonRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
AbandonRequest	addControl(Control control) Adds a control to this Message.
int	getAbandoned() Gets the id of the request operation to terminate.
AbandonRequest	removeControl(Control control) Deletes a control removing it from this Message.
AbandonRequest	setAbandoned(int requestId) Sets the id of the request operation to terminate.
AbandonRequest	setMessageId(int messageId) Sets the Message ID for this request

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

hasResponse

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

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

Field Detail

TYPE

static final MessageTypeEnum TYPE

Ldap abandon request type code

Method Detail

getAbandoned

int getAbandoned()

Gets the id of the request operation to terminate.

Returns:

the id of the request message to abandon

setAbandoned

AbandonRequest setAbandoned(int requestId)

Sets the id of the request operation to terminate.

Parameters:

requestId - the sequence id of the request message to abandon

Returns:

The AbandonRequest instance

setMessageId

AbandonRequest 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

AbandonRequest 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

AbandonRequest 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

AbandonRequest 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.