Module io.inverno.mod.http.server
Package io.inverno.mod.http.server

Interface ResponseHeaders

public interface ResponseHeaders

Represents the HTTP headers of a server response in a server exchange as defined by RFC 7230 Section 3.2.

Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Method Details

    • status

      ResponseHeaders status(Status status)

      Sets the response HTTP status.

      Parameters:
      status - the HTTP status
      Returns:
      the response headers

    • status

      ResponseHeaders status(int status)

      Sets the response HTTP status code

      Parameters:
      status - the HTTP status code
      Returns:
      the response headers

    • contentType

      ResponseHeaders contentType(String contentType)

      Sets the response content type header field value.

      Parameters:
      contentType - the content type
      Returns:
      the response headers

    • contentLength

      ResponseHeaders contentLength(long length)

      Sets the response content length.

      Parameters:
      length - the content length
      Returns:
      the response headers

    • add

      ResponseHeaders add(CharSequence name, CharSequence value)

      Adds a header with the specified name and value.

      Parameters:
      name - the header name
      value - the header value
      Returns:
      the response headers

    • add

      ResponseHeaders add(Header... headers)

      Adds the specified headers.

      Parameters:
      headers - the headers to add
      Returns:
      the response headers

    • set

      ResponseHeaders set(CharSequence name, CharSequence value)

      Sets the value of the header with the specified name.

      Parameters:
      name - the header name
      value - the header value
      Returns:
      the response headers

    • set

      ResponseHeaders set(Header... headers)

      Sets the specified headers.

      Parameters:
      headers - the headers to set
      Returns:
      the response headers

    • remove

      ResponseHeaders remove(CharSequence... names)

      Removes the headers with the specified names.

      Parameters:
      names - the names of the headers to remove
      Returns:
      the response headers

    • getStatus

      Status getStatus()

      Returns the response HTTP status.

      Returns:
      the response status

    • getStatusCode

      int getStatusCode()

      Returns the response HTTP status code.

      Returns:
      the response status code

    • getContentType

      Optional<String> getContentType()

      Returns the response content type header field value.

      Returns:
      an optional returning the content type or an empty optional if there's no content type header

    • getContentTypeHeader

      Optional<Headers.ContentType> getContentTypeHeader()

      Decodes and returns the response content type header.

      Returns:
      an optional returning the content type header or an empty optional if there's no content type header

    • contains

      boolean contains(CharSequence name)

      Determines whether a header with the specified name is present.

      Parameters:
      name - a header name
      Returns:
      true if a header is present, false otherwise

    • contains

      boolean contains(CharSequence name, CharSequence value)

      Determines whether a header with the specified name and value is present.

      Parameters:
      name - a header name
      value - a header value
      Returns:
      true if a header is present, false otherwise

    • getNames

      Set<String> getNames()

      Returns the names of the headers in the response.

      Returns:
      a list of header names

    • get

      Optional<String> get(CharSequence name)

      Returns the value of the header with the specified name.

      If there are multiple headers with the same name, this method returns the first one.

      Parameters:
      name - a header name
      Returns:
      an optional returning the value of the header or an empty optional if there's no header with the specified name

    • getAll

      List<String> getAll(CharSequence name)

      Returns the values of all headers with the specified name.

      Parameters:
      name - a header name
      Returns:
      a list of header values or an empty list if there's no header with the specified name

    • getAll

      List<Map.Entry<String,String>> getAll()

      Returns all headers in the response.

      Returns:
      a list of header entries or an empty list if there's no header

    • getHeader

      <T extends Header> Optional<T> getHeader(CharSequence name)

      Decodes and returns the header with the specified name.

      If there are multiple headers with the same name, this method returns the first one.

      Type Parameters:
      T - the decoded header type
      Parameters:
      name - a header name
      Returns:
      an optional returning the decoded header or an empty optional if there's no header with the specified name

    • getAllHeader

      <T extends Header> List<T> getAllHeader(CharSequence name)

      Decodes and returns all headers with the specified name.

      Type Parameters:
      T - the decoded header type
      Parameters:
      name - a header name
      Returns:
      a list of header values or an empty list if there's no header with the specified name

    • getAllHeader

      List<Header> getAllHeader()

      Decodes and returns all headers in the response.

      Returns:
      a list of headers or an empty list if there's no header

    • getParameter

      Optional<Parameter> getParameter(CharSequence name)

      Returns the header with the specified name as a parameter.

      If there are multiple headers with the same name, this method returns the first one.

      Parameters:
      name - a header name
      Returns:
      an optional returning the parameter or an empty optional if there's no header with the specified name

    • getAllParameter

      List<Parameter> getAllParameter(CharSequence name)

      Returns all headers with the specified name as parameters.

      Parameters:
      name - a header name
      Returns:
      a list of parameters or an empty list if there's no header with the specified name

    • getAllParameter

      List<Parameter> getAllParameter()

      Returns all headers in the response as parameters.

      Returns:
      a list of parameters or an empty list if there's no header