org.forgerock.opendj.ldap.messages

Interface AbandonRequest

All Superinterfaces:

ProtocolOp, Request

public interface AbandonRequest
extends Request

The Abandon operation allows a client to request that the server abandon an uncompleted operation.

Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request

Request.RequestType

Method Summary

Modifier and Type	Method and Description
AbandonRequest	addControl(Control control) Adds the provided control to this protocol-op.
AbandonRequest	addControls(Iterable<? extends Control> controls) Adds the provided controls to this protocol-op.
<C extends Control> C	getControl(ControlDecoder<C> decoder, DecodeOptions options) Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
List<Control>	getControls() Returns a List containing the controls included with this protocol-op.
int	getRequestId() Returns the request ID of the request to be abandoned.
AbandonRequest	setRequestId(int id) Sets the request ID of the request to be abandoned.

Methods inherited from interface org.forgerock.opendj.ldap.messages.Request

accept, getType

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Method Detail

addControl

AbandonRequest addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

AbandonRequest addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Request

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException

Description copied from interface: ProtocolOp

Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface ProtocolOp

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

DecodeException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

getControls

List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

getRequestId

int getRequestId()

Returns the request ID of the request to be abandoned.

Returns:

The request ID of the request to be abandoned.

setRequestId

AbandonRequest setRequestId(int id)

Sets the request ID of the request to be abandoned.

Parameters:

id - The request ID of the request to be abandoned.

Returns:

This abandon request.

Throws:

UnsupportedOperationException - If this abandon request does not permit the request ID to be set.