Package org.forgerock.opendj.ldap.messages

Record Class CancelExtendedRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.CancelExtendedRequest
Record Components:
requestId - the request ID of the request to be abandoned.
controls - the List containing the controls.
All Implemented Interfaces:
ExtendedRequest<ExtendedResult>, ProtocolOp, Request
public record CancelExtendedRequest(int requestId, List<Control> controls) extends Record 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:

  • Field Details

  • Constructor Details

    • CancelExtendedRequest

      public CancelExtendedRequest(int requestId, List<Control> controls)
      Creates a new CancelExtendedRequest.

  • 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>
      Returns:
      The numeric OID associated with this extended request.

    • 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>
      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>
      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 an extended request has a value, without actually calculating the value and incurring any performance costs.
      Specified by:
      hasValue in interface ExtendedRequest<ExtendedResult>
      Returns:
      true if this extended request has a value, or false if there is no value.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • requestId

      public int requestId()
      Returns the value of the requestId record component.
      Returns:
      the value of the requestId record component

    • controls

      public List<Control> controls()
      Returns the value of the controls record component.
      Specified by:
      controls in interface ProtocolOp
      Returns:
      the value of the controls record component