Package org.forgerock.opendj.ldap.requests

Interface AbandonRequest

All Superinterfaces:

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.

Method Summary

Modifier and Type	Method	Description
AbandonRequest	addControl(Control control)	Adds the provided control to this request.
<C extends Control> C	getControl(ControlDecoder<C> decoder, DecodeOptions options)	Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.
List<Control>	getControls()	Returns a List containing the controls included with this request.
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.requests.Request

containsControl

Method Detail

addControl

AbandonRequest addControl(Control control)

Description copied from interface: Request

Adds the provided control to this request.

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this request.

Returns:

This request.

getControl

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

Description copied from interface: Request

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

Specified by:

getControl in interface Request

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

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: Request

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

Specified by:

getControls in interface Request

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.