Package org.forgerock.opendj.ldap.messages

Record Class GenericExtendedRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.GenericExtendedRequest
Record Components:
requestName - the numeric OID associated with this extended request.
requestValue - the value associated with this extended request, or null if there is no value. Its format is defined by the specification of this control.
controls - the List containing the controls.
All Implemented Interfaces:
ExtendedRequest<GenericExtendedResult>, ProtocolOp, Request
public record GenericExtendedRequest(String requestName, ByteString requestValue, List<Control> controls) extends Record implements ExtendedRequest<GenericExtendedResult>
A generic Extended request which should be used for unsupported extended operations. Servers list the names of Extended requests they recognize in the supportedExtension attribute in the root DSE. Where the name is not recognized, the server returns ResultCode.PROTOCOL_ERROR (the server may return this error in other cases).

  • Field Details

  • Constructor Details

    • GenericExtendedRequest

      public GenericExtendedRequest(String requestName, ByteString requestValue, List<Control> controls)
      Creates a new GenericExtendedRequest.

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

    • getResultDecoder

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

    • requestName

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

    • requestValue

      public ByteString requestValue()
      Returns the value of the requestValue record component.
      Returns:
      the value of the requestValue 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