Package org.microproxy.frames

Record Class Http2Frame.Headers

java.lang.Object
java.lang.Record
org.microproxy.frames.Http2Frame.Headers
Record Components:
streamId - the stream
fields - the header block, pseudo-headers first
endStream - whether the frame ends the stream
All Implemented Interfaces:
Http2Frame, HttpFrame
Enclosing interface:
Http2Frame
public static record Http2Frame.Headers(int streamId, List<Field> fields, boolean endStream) extends Record implements Http2Frame
HEADERS (section 6.2), with its whole decoded header block. The deprecated priority signal a client may put in HEADERS is not shown.

  • Constructor Details

    • Headers

      public Headers(int streamId, List<Field> fields, boolean endStream)
      Creates HEADERS.
      Parameters:
      streamId - the stream, 1 or more
      fields - the header block, copied
      endStream - whether the frame ends the stream

  • Method Details

    • typeName

      public String typeName()
      Description copied from interface: HttpFrame
      The frame type's name as the protocol's RFC spells it (DATA, HEADERS, SETTINGS, ...), or UNKNOWN for an extension or reserved type.
      Specified by:
      typeName in interface HttpFrame
      Returns:
      the frame type name

    • typeCode

      public long typeCode()
      Description copied from interface: HttpFrame
      The frame type's code on the wire.
      Specified by:
      typeCode in interface HttpFrame
      Returns:
      the unsigned type code

    • get

      public String get(String name)
      The first value of a field.
      Parameters:
      name - the field name, lower case
      Returns:
      the value, or null if there is no such field

    • withFields

      public Http2Frame.Headers withFields(List<Field> newFields)
      This frame with another header block.
      Parameters:
      newFields - the new header block
      Returns:
      a copy with the fields

    • withHeader

      public Http2Frame.Headers withHeader(String name, String value)
      This frame with name set to value: the first field of that name gets the value and later ones are removed; without one, the field is added (a pseudo-header after the other pseudo-headers, a regular field at the end).
      Parameters:
      name - the field name, lower case
      value - the value
      Returns:
      a copy with the field set

    • withoutHeader

      public Http2Frame.Headers withoutHeader(String name)
      This frame without the fields named name.
      Parameters:
      name - the field name, lower case
      Returns:
      a copy without them

    • withEndStream

      public Http2Frame.Headers withEndStream(boolean end)
      This frame with END_STREAM set or not (see FrameInterceptor for who decides).
      Parameters:
      end - whether the frame ends the stream
      Returns:
      a copy with the flag

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

    • streamId

      public int streamId()
      Returns the value of the streamId record component.
      Specified by:
      streamId in interface Http2Frame
      Returns:
      the value of the streamId record component

    • fields

      public List<Field> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component

    • endStream

      public boolean endStream()
      Returns the value of the endStream record component.
      Returns:
      the value of the endStream record component