Package org.forgerock.opendj.ldap.messages

Record Class InvalidRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.InvalidRequest
Record Components:
invalidRequestType - the LDAP protocol-op type.
rawDn - the raw representation of the DN. May be null if the request has no DN.
reason - the reason for which this request is invalid.
All Implemented Interfaces:
ProtocolOp, Request
public record InvalidRequest(Request.RequestType invalidRequestType, String rawDn, LdapException reason) extends Record implements Request
Represents a request which has been received and decoded but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.

  • Constructor Details

    • InvalidRequest

      public InvalidRequest(Request.RequestType invalidRequestType, String rawDn, LdapException reason)
      Create new InvalidRequest with the invalid request type, the raw DN and the LdapException reason.

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

    • getType

      public Request.RequestType getType()
      Returns the type of this request to avoid expensive instanceof checks.
      Specified by:
      getType in interface Request
      Returns:
      Always Request.RequestType.INVALID.
      See Also:

    • getControl

      public <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options)
      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.

    • controls

      public List<Control> controls()
      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:
      controls in interface ProtocolOp
      Returns:
      A List containing the controls.

    • containsControl

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

    • addControl

      public InvalidRequest 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 InvalidRequest 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 InvalidRequest 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.

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • invalidRequestType

      public Request.RequestType invalidRequestType()
      Returns the value of the invalidRequestType record component.
      Returns:
      the value of the invalidRequestType record component

    • rawDn

      public String rawDn()
      Returns the value of the rawDn record component.
      Returns:
      the value of the rawDn record component

    • reason

      public LdapException reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component