Interface Header

All Superinterfaces:
io.helidon.common.mapper.Value<String>
All Known Subinterfaces:
HeaderWriteable
All Known Implementing Classes:
ContentDisposition

public interface Header extends io.helidon.common.mapper.Value<String>
HTTP Header with HeaderName and value.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    All values of this header.
    default List<String>
    allValues(boolean split)
    All values of this header.
    boolean
    Changing headers should not be cached, and their value should not be indexed (HTTP/2).
    Header name for the header.
    Name of the header as configured by user or as received on the wire.
    boolean
    Sensitive headers should not be logged, or indexed (HTTP/2).
    default void
    Check validity of header name and values.
    default String
    Deprecated, for removal: This API element is subject to removal in a future version.
    use Value.get()
    default byte[]
    Cached bytes of a single valued header's value.
    int
    Number of values this header has.
    default String
    All values concatenated using a comma.
    default void
    writeHttp1Header(io.helidon.common.buffers.BufferData buffer)
    Write the current header as an HTTP header to the provided buffer.

    Methods inherited from interface io.helidon.common.mapper.Value

    as, as, as, asBoolean, asDouble, asInt, asLong, asOptional, asString, filter, flatMap, get, get, get, getBoolean, getDouble, getInt, getLong, getString, stream
  • Method Details

    • name

      String name()
      Name of the header as configured by user or as received on the wire.
      Specified by:
      name in interface io.helidon.common.mapper.Value<String>
      Returns:
      header name, always lower case for HTTP/2 headers
    • value

      @Deprecated(forRemoval=true, since="4.0.0") default String value()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Value.get()
      Value of the header.
      Returns:
      header value
    • headerName

      HeaderName headerName()
      Header name for the header.
      Returns:
      header name
    • values

      default String values()
      All values concatenated using a comma.
      Returns:
      all values joined by a comma
    • allValues

      List<String> allValues()
      All values of this header.
      Returns:
      all configured values
    • allValues

      default List<String> allValues(boolean split)
      All values of this header. If this header is defined as a single header with comma separated values, set split to true.
      Parameters:
      split - whether to split single value by comma, does nothing if the value is already a list.
      Returns:
      list of values
    • valueCount

      int valueCount()
      Number of values this header has.
      Returns:
      number of values (minimal number is 1)
    • sensitive

      boolean sensitive()
      Sensitive headers should not be logged, or indexed (HTTP/2).
      Returns:
      whether this header is sensitive
    • changing

      boolean changing()
      Changing headers should not be cached, and their value should not be indexed (HTTP/2).
      Returns:
      whether this header's value is changing often
    • valueBytes

      default byte[] valueBytes()
      Cached bytes of a single valued header's value.
      Returns:
      value bytes
    • writeHttp1Header

      default void writeHttp1Header(io.helidon.common.buffers.BufferData buffer)
      Write the current header as an HTTP header to the provided buffer.
      Parameters:
      buffer - buffer to write to (should be growing)
    • validate

      default void validate() throws IllegalArgumentException
      Check validity of header name and values.
      Throws:
      IllegalArgumentException - in case the HeaderValue is not valid