org.forgerock.opendj.ldap.messages.AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>

org.forgerock.opendj.ldap.messages.CancelExtendedRequest

All Implemented Interfaces:: ExtendedRequest<ExtendedResult>, ProtocolOp, Request

public final class CancelExtendedRequest extends AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult> implements ExtendedRequest<ExtendedResult>

The cancel extended request as defined in RFC 3909. This operation is similar to the abandon operation, except that it has a response and also requires the abandoned operation to return a response indicating it was canceled. This operation should be used instead of the abandon operation when the client needs an indication of the outcome. This operation may be used to cancel both interrogation and update operations.

See Also:

RFC 3909 - Lightweight Directory Access Protocol (LDAP) Cancel Operation

Nested Class Summary

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

Fields

Modifier and Type

Field

Description

static final ExtendedRequestDecoder<CancelExtendedRequest,ExtendedResult>

DECODER

A decoder which can be used to decode cancel extended operation requests.

static final String

OID

The OID for the cancel extended operation request.
Method Summary

Modifier and Type

Method

Description

final CancelExtendedRequest

addControl(Control control)

Adds the provided control to this protocol-op.

final CancelExtendedRequest

addControls(Iterable<? extends Control> controls)

Adds the provided controls to this protocol-op.

final boolean

containsControl(String oid)

Returns true if this protocol-op contains the specified control.

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

final List<Control>

getControls()

Returns a List containing the controls included with this protocol-op.

String

getOid()

Returns the numeric OID associated with this extended request.

int

getRequestId()

Returns the request ID of the request to be abandoned.

ExtendedResultDecoder<ExtendedResult>

getResultDecoder()

Returns a decoder which can be used to decoded responses to this extended request.

ByteString

getValue()

Returns the value, if any, associated with this extended request.

boolean

hasValue()

Returns true if this extended request has a value.

final CancelExtendedRequest

removeControls(String oid)

Removes all the controls having the specified OID.

CancelExtendedRequest

setRequestId(int id)

Sets the request ID of the request to be abandoned.

String

toString()

Methods inherited from class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
accept, getType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.forgerock.opendj.ldap.messages.ExtendedRequest
addControl, addControls, getControl, getControls, removeControls

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp
containsControl, getControl

Methods inherited from interface org.forgerock.opendj.ldap.messages.Request
accept, getType

Field Details
- DECODER
  
  public static final ExtendedRequestDecoder<CancelExtendedRequest,ExtendedResult> DECODER
  
  A decoder which can be used to decode cancel extended operation requests.
- OID
  
  public static final String OID
  
  The OID for the cancel extended operation request.
  See Also:
  
  Constant Field Values
Method Details
- getOid
  
  public String getOid()
  
  Description copied from interface: ExtendedRequest
  
  Returns the numeric OID associated with this extended request.
  
  Specified by:
  
  getOid in interface ExtendedRequest<ExtendedResult>
  
  Specified by:
  
  getOid in class AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>
  
  Returns:
  
  The numeric OID associated with this extended request.
- getRequestId
  
  public int getRequestId()
  
  Returns the request ID of the request to be abandoned.
  
  Returns:
  
  The request ID of the request to be abandoned.
- getResultDecoder
  
  public ExtendedResultDecoder<ExtendedResult> getResultDecoder()
  
  Description copied from interface: ExtendedRequest
  
  Returns a decoder which can be used to decoded responses to this extended request.
  
  Specified by:
  
  getResultDecoder in interface ExtendedRequest<ExtendedResult>
  
  Specified by:
  
  getResultDecoder in class AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>
  
  Returns:
  
  A decoder which can be used to decoded responses to this extended request.
- getValue
  
  public ByteString getValue()
  
  Description copied from interface: ExtendedRequest
  
  Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.
  
  Specified by:
  
  getValue in interface ExtendedRequest<ExtendedResult>
  
  Specified by:
  
  getValue in class AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>
  
  Returns:
  
  The value associated with this extended request, or null if there is no value.
- hasValue
  
  public boolean hasValue()
  
  Description copied from interface: ExtendedRequest
  
  Returns true if this extended request has a value. In some circumstances it may be useful to determine if a extended request has a value, without actually calculating the value and incurring any performance costs.
  
  Specified by:
  
  hasValue in interface ExtendedRequest<ExtendedResult>
  
  Specified by:
  
  hasValue in class AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>
  
  Returns:
  
  true if this extended request has a value, or false if there is no value.
- setRequestId
  
  public CancelExtendedRequest 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.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class AbstractExtendedRequest<CancelExtendedRequest,ExtendedResult>
- addControl
  
  public final CancelExtendedRequest addControl(Control control)
  
  Description copied from interface: ProtocolOp
  
  Adds the provided control to this protocol-op.
  
  Specified by:
  
  addControl in interface ProtocolOp
  
  Parameters:
  
  control - The control to be added to this protocol-op.
  
  Returns:
  
  This protocol-op.
- addControls
  
  public final CancelExtendedRequest addControls(Iterable<? extends Control> controls)
  
  Description copied from interface: ProtocolOp
  
  Adds the provided controls to this protocol-op.
  
  Specified by:
  
  addControls in interface ProtocolOp
  
  Parameters:
  
  controls - The controls to be added to this protocol-op.
  
  Returns:
  
  This protocol-op.
- removeControls
  
  public final CancelExtendedRequest removeControls(String oid)
  
  Description copied from interface: ProtocolOp
  
  Removes all the controls having the specified OID.
  
  Specified by:
  
  removeControls in interface ProtocolOp
  
  Parameters:
  
  oid - The numeric OID of the protocol-op control to remove.
  
  Returns:
  
  This protocol-op.
- containsControl
  
  public final boolean containsControl(String oid)
  
  Description copied from interface: ProtocolOp
  
  Returns true if this protocol-op contains the specified control.
  
  Specified by:
  
  containsControl in interface ProtocolOp
  
  Parameters:
  
  oid - The numeric OID of the protocol-op control.
  
  Returns:
  
  true if this protocol-op contains the specified control.
- getControl
  
  public final <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
  
  public final 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.

Class CancelExtendedRequest

Nested Class Summary

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

Field Summary

Method Summary

Methods inherited from class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest

Methods inherited from class java.lang.Object

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

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

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

Field Details

DECODER

OID

Method Details

getOid

getRequestId

getResultDecoder

getValue

hasValue

setRequestId

toString

addControl

addControls

removeControls

containsControl

getControl

getControls