Package org.forgerock.opendj.ldap.messages

Record Class AbandonRequest

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

  • Constructor Details

    • AbandonRequest

      public AbandonRequest(int requestId, List<Control> controls)
      Create new AbandonRequest.

  • Method Details

    • accept

      public <R, P, E extends Exception> R accept(RequestVisitor<R,P,E> v, P p) throws E
      Description copied from interface: Request
      Applies a RequestVisitor to this Request.
      Specified by:
      accept in interface Request
      Type Parameters:
      R - The return type of the visitor's methods.
      P - The type of the additional parameters to the visitor's methods.
      E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.
      Parameters:
      v - The request visitor.
      p - Optional additional visitor parameter.
      Returns:
      A result as specified by the visitor.
      Throws:
      E - If the visitor failed.

    • getRequestId

      public int getRequestId()
      Returns the request ID of the request to be abandoned.
      Returns:
      The request ID of the request to be abandoned.

    • getType

      public Request.RequestType getType()
      Description copied from interface: Request
      Returns the type of this request to avoid expensive instanceof checks.
      Specified by:
      getType in interface Request
      Returns:
      the type of this request

    • 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