Interface HttpHeaders

  • All Superinterfaces:
    io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String>, io.micronaut.core.convert.value.ConvertibleValues<java.util.List<java.lang.String>>, io.micronaut.core.type.Headers, java.lang.Iterable<java.util.Map.Entry<java.lang.String,​java.util.List<java.lang.String>>>, io.micronaut.core.value.ValueResolver<java.lang.CharSequence>
    All Known Subinterfaces:
    MutableHttpHeaders
    All Known Implementing Classes:
    CaseInsensitiveMutableHttpHeaders, SimpleHttpHeaders

    public interface HttpHeaders
    extends io.micronaut.core.type.Headers
    Constants for common HTTP headers. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.
    Since:
    1.0
    • Method Detail

      • findDate

        default java.util.Optional<java.time.ZonedDateTime> findDate​(java.lang.CharSequence name)
        Obtain the date header.
        Parameters:
        name - The header name
        Returns:
        The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed Optional.empty()
      • getDate

        default java.time.ZonedDateTime getDate​(java.lang.CharSequence name)
        Obtain the date header.
        Parameters:
        name - The header name
        Returns:
        The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed null
      • getInt

        default java.lang.Integer getInt​(java.lang.CharSequence name)
        Obtain an integer header.
        Parameters:
        name - The header name
        Returns:
        The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed null
      • findInt

        default java.util.Optional<java.lang.Integer> findInt​(java.lang.CharSequence name)
        Find an integer header.
        Parameters:
        name - The name of the header
        Returns:
        An Optional of Integer
      • findFirst

        default java.util.Optional<java.lang.String> findFirst​(java.lang.CharSequence name)
        Get the first value of the given header.
        Parameters:
        name - The header name
        Returns:
        The first value or null if it is present
      • contentType

        default java.util.Optional<MediaType> contentType()
        The request or response content type.
        Returns:
        The content type
      • contentLength

        default java.util.OptionalLong contentLength()
        The request or response content type.
        Returns:
        The content type
      • accept

        default java.util.List<MediaType> accept()
        A list of accepted MediaType instances.
        Returns:
        A list of zero or many MediaType instances
      • isKeepAlive

        default boolean isKeepAlive()
        Returns:
        Whether the CONNECTION header is set to Keep-Alive
      • getOrigin

        default java.util.Optional<java.lang.String> getOrigin()
        Returns:
        The ORIGIN header
      • getAuthorization

        default java.util.Optional<java.lang.String> getAuthorization()
        Returns:
        The AUTHORIZATION header
      • getContentType

        default java.util.Optional<java.lang.String> getContentType()
        Returns:
        The CONTENT_TYPE header