Package io.micronaut.http.netty

Class NettyHttpHeaders

java.lang.Object
io.micronaut.http.netty.NettyHttpHeaders
All Implemented Interfaces:
io.micronaut.core.convert.ConversionServiceAware, io.micronaut.core.convert.ConversionServiceProvider, io.micronaut.core.convert.value.ConvertibleMultiValues<String>, io.micronaut.core.convert.value.ConvertibleValues<List<String>>, io.micronaut.core.type.Headers, io.micronaut.core.type.MutableHeaders, io.micronaut.core.value.ValueResolver<CharSequence>, io.micronaut.http.HttpHeaders, io.micronaut.http.MutableHttpHeaders, Iterable<Map.Entry<String,List<String>>>
@Internal public class NettyHttpHeaders extends Object implements io.micronaut.http.MutableHttpHeaders
Delegates to Netty's HttpHeaders.
Since:
1.0

  • Field Summary

    Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

    EMPTY

    Fields inherited from interface io.micronaut.http.HttpHeaders

    ACCEPT, ACCEPT_CH, ACCEPT_CH_LIFETIME, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_PATCH, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK, AGE, ALLOW, AUTHORIZATION, AUTHORIZATION_INFO, CACHE_CONTROL, CONNECTION, CONTENT_BASE, CONTENT_DISPOSITION, CONTENT_DPR, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, CROSS_ORIGIN_RESOURCE_POLICY, DATE, DEVICE_MEMORY, DOWNLINK, DPR, ECT, ETAG, EXPECT, EXPIRES, FEATURE_POLICY, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, REFERRER_POLICY, RETRY_AFTER, RTT, SAVE_DATA, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_KEY1, SEC_WEBSOCKET_KEY2, SEC_WEBSOCKET_LOCATION, SEC_WEBSOCKET_ORIGIN, SEC_WEBSOCKET_PROTOCOL, SEC_WEBSOCKET_VERSION, SERVER, SET_COOKIE, SET_COOKIE2, SOURCE_MAP, STANDARD_HEADERS, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, VIEWPORT_WIDTH, WARNING, WEBSOCKET_LOCATION, WEBSOCKET_ORIGIN, WEBSOCKET_PROTOCOL, WIDTH, WWW_AUTHENTICATE, X_AUTH_TOKEN

    Fields inherited from interface io.micronaut.http.MutableHttpHeaders

    GMT

  • Constructor Summary

    Constructors
    Constructor
    Description
    NettyHttpHeaders()
    Default constructor.
    NettyHttpHeaders(io.netty.handler.codec.http.HttpHeaders nettyHeaders, io.micronaut.core.convert.ConversionService conversionService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<io.micronaut.http.MediaType>
    accept()
     
    io.micronaut.http.MutableHttpHeaders
    add(CharSequence header, CharSequence value)
     
    io.micronaut.http.MutableHttpHeaders
    allowGeneric(Collection<? extends CharSequence> methods)
     
    io.micronaut.http.MutableHttpHeaders
    auth(String userInfo)
     
    final boolean
    contains(CharSequence name)
     
    final boolean
    contains(String name)
     
    OptionalLong
    contentLength()
     
    Optional<io.micronaut.http.MediaType>
    contentType()
     
    io.micronaut.http.MutableHttpHeaders
    contentType(io.micronaut.http.MediaType mediaType)
     
    io.micronaut.http.MutableHttpHeaders
    contentTypeIfMissing(io.micronaut.http.MediaType mediaType)
     
    io.micronaut.http.MutableHttpHeaders
    date(long timeInMillis)
     
    io.micronaut.http.MutableHttpHeaders
    date(LocalDateTime date)
     
    io.micronaut.http.MutableHttpHeaders
    expires(long timeInMillis)
     
    io.micronaut.http.MutableHttpHeaders
    expires(LocalDateTime date)
     
    Optional<Charset>
    findAcceptCharset()
     
    Optional<Locale>
    findAcceptLanguage()
     
    Optional<String>
    findFirst(CharSequence name)
     
    String
    get(CharSequence name)
     
    <T> Optional<T>
    get(CharSequence name, io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)
     
    List<String>
    getAll(CharSequence name)
     
    io.micronaut.core.convert.ConversionService
    getConversionService()
     
    io.netty.handler.codec.http.HttpHeaders
    getNettyHeaders()
    Note: Caller must take care to validate headers inserted into this object!
    Optional<String>
    getOrigin()
     
    io.micronaut.http.MutableHttpHeaders
    ifModifiedSince(long timeInMillis)
     
    io.micronaut.http.MutableHttpHeaders
    ifModifiedSince(LocalDateTime date)
     
    io.micronaut.http.MutableHttpHeaders
    lastModified(long timeInMillis)
     
    io.micronaut.http.MutableHttpHeaders
    lastModified(LocalDateTime date)
     
    io.micronaut.http.MutableHttpHeaders
    location(URI uri)
     
    Set<String>
    names()
     
    io.micronaut.http.MutableHttpHeaders
    remove(CharSequence header)
     
    io.micronaut.core.type.MutableHeaders
    set(CharSequence header, CharSequence value)
     
    void
    setConversionService(io.micronaut.core.convert.ConversionService conversionService)
     
    void
    setUnsafe(CharSequence header, CharSequence value)
    Like set(CharSequence, CharSequence) but without header validation.
    static void
    validateHeader(CharSequence name, CharSequence value)
     
    Collection<List<String>>
    values()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues

    forEach, forEachValue, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator

    Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

    asMap, asMap, asProperties, getValue, getValueType, subMap, subMap, subMap

    Methods inherited from interface io.micronaut.http.HttpHeaders

    acceptCharset, acceptLanguage, findDate, findInt, getAuthorization, getContentType, getDate, getInt, isKeepAlive

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface io.micronaut.core.type.MutableHeaders

    setIfMissing

    Methods inherited from interface io.micronaut.http.MutableHttpHeaders

    add, add, allow, allow, auth

    Methods inherited from interface io.micronaut.core.value.ValueResolver

    get, get, get

  • Constructor Details

    • NettyHttpHeaders

      public NettyHttpHeaders(io.netty.handler.codec.http.HttpHeaders nettyHeaders, io.micronaut.core.convert.ConversionService conversionService)
      Parameters:
      nettyHeaders - The Netty Http headers
      conversionService - The conversion service

    • NettyHttpHeaders

      public NettyHttpHeaders()
      Default constructor.

  • Method Details

    • getNettyHeaders

      public io.netty.handler.codec.http.HttpHeaders getNettyHeaders()
      Note: Caller must take care to validate headers inserted into this object!
      Returns:
      The underlying Netty headers.

    • contains

      public final boolean contains(String name)
      Specified by:
      contains in interface io.micronaut.core.convert.value.ConvertibleValues<List<String>>

    • contains

      public final boolean contains(CharSequence name)
      Specified by:
      contains in interface io.micronaut.http.HttpHeaders

    • get

      public <T> Optional<T> get(CharSequence name, io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)
      Specified by:
      get in interface io.micronaut.core.value.ValueResolver<CharSequence>

    • getAll

      public List<String> getAll(CharSequence name)
      Specified by:
      getAll in interface io.micronaut.core.convert.value.ConvertibleMultiValues<String>

    • names

      public Set<String> names()
      Specified by:
      names in interface io.micronaut.core.convert.value.ConvertibleValues<List<String>>

    • values

      public Collection<List<String>> values()
      Specified by:
      values in interface io.micronaut.core.convert.value.ConvertibleValues<List<String>>

    • get

      public String get(CharSequence name)
      Specified by:
      get in interface io.micronaut.core.convert.value.ConvertibleMultiValues<String>

    • findFirst

      public Optional<String> findFirst(CharSequence name)
      Specified by:
      findFirst in interface io.micronaut.http.HttpHeaders

    • add

      public io.micronaut.http.MutableHttpHeaders add(CharSequence header, CharSequence value)
      Specified by:
      add in interface io.micronaut.core.type.MutableHeaders
      Specified by:
      add in interface io.micronaut.http.MutableHttpHeaders

    • set

      public io.micronaut.core.type.MutableHeaders set(CharSequence header, CharSequence value)
      Specified by:
      set in interface io.micronaut.core.type.MutableHeaders
      Specified by:
      set in interface io.micronaut.http.MutableHttpHeaders

    • setUnsafe

      public void setUnsafe(CharSequence header, CharSequence value)
      Like set(CharSequence, CharSequence) but without header validation.
      Parameters:
      header - The header name
      value - The header value

    • validateHeader

      public static void validateHeader(CharSequence name, CharSequence value)

    • remove

      public io.micronaut.http.MutableHttpHeaders remove(CharSequence header)
      Specified by:
      remove in interface io.micronaut.core.type.MutableHeaders
      Specified by:
      remove in interface io.micronaut.http.MutableHttpHeaders

    • date

      public io.micronaut.http.MutableHttpHeaders date(LocalDateTime date)
      Specified by:
      date in interface io.micronaut.http.MutableHttpHeaders

    • expires

      public io.micronaut.http.MutableHttpHeaders expires(LocalDateTime date)
      Specified by:
      expires in interface io.micronaut.http.MutableHttpHeaders

    • lastModified

      public io.micronaut.http.MutableHttpHeaders lastModified(LocalDateTime date)
      Specified by:
      lastModified in interface io.micronaut.http.MutableHttpHeaders

    • ifModifiedSince

      public io.micronaut.http.MutableHttpHeaders ifModifiedSince(LocalDateTime date)
      Specified by:
      ifModifiedSince in interface io.micronaut.http.MutableHttpHeaders

    • date

      public io.micronaut.http.MutableHttpHeaders date(long timeInMillis)
      Specified by:
      date in interface io.micronaut.http.MutableHttpHeaders

    • expires

      public io.micronaut.http.MutableHttpHeaders expires(long timeInMillis)
      Specified by:
      expires in interface io.micronaut.http.MutableHttpHeaders

    • lastModified

      public io.micronaut.http.MutableHttpHeaders lastModified(long timeInMillis)
      Specified by:
      lastModified in interface io.micronaut.http.MutableHttpHeaders

    • ifModifiedSince

      public io.micronaut.http.MutableHttpHeaders ifModifiedSince(long timeInMillis)
      Specified by:
      ifModifiedSince in interface io.micronaut.http.MutableHttpHeaders

    • auth

      public io.micronaut.http.MutableHttpHeaders auth(String userInfo)
      Specified by:
      auth in interface io.micronaut.http.MutableHttpHeaders

    • allowGeneric

      public io.micronaut.http.MutableHttpHeaders allowGeneric(Collection<? extends CharSequence> methods)
      Specified by:
      allowGeneric in interface io.micronaut.http.MutableHttpHeaders

    • location

      public io.micronaut.http.MutableHttpHeaders location(URI uri)
      Specified by:
      location in interface io.micronaut.http.MutableHttpHeaders

    • contentType

      public io.micronaut.http.MutableHttpHeaders contentType(io.micronaut.http.MediaType mediaType)
      Specified by:
      contentType in interface io.micronaut.http.MutableHttpHeaders

    • contentTypeIfMissing

      public io.micronaut.http.MutableHttpHeaders contentTypeIfMissing(io.micronaut.http.MediaType mediaType)
      Specified by:
      contentTypeIfMissing in interface io.micronaut.http.MutableHttpHeaders

    • getConversionService

      public io.micronaut.core.convert.ConversionService getConversionService()
      Specified by:
      getConversionService in interface io.micronaut.core.convert.ConversionServiceProvider
      Specified by:
      getConversionService in interface io.micronaut.core.convert.value.ConvertibleValues<List<String>>

    • setConversionService

      public void setConversionService(io.micronaut.core.convert.ConversionService conversionService)
      Specified by:
      setConversionService in interface io.micronaut.core.convert.ConversionServiceAware

    • contentType

      public Optional<io.micronaut.http.MediaType> contentType()
      Specified by:
      contentType in interface io.micronaut.http.HttpHeaders

    • contentLength

      public OptionalLong contentLength()
      Specified by:
      contentLength in interface io.micronaut.http.HttpHeaders

    • accept

      public List<io.micronaut.http.MediaType> accept()
      Specified by:
      accept in interface io.micronaut.http.HttpHeaders

    • findAcceptCharset

      public Optional<Charset> findAcceptCharset()
      Specified by:
      findAcceptCharset in interface io.micronaut.http.HttpHeaders

    • findAcceptLanguage

      public Optional<Locale> findAcceptLanguage()
      Specified by:
      findAcceptLanguage in interface io.micronaut.http.HttpHeaders

    • getOrigin

      public Optional<String> getOrigin()
      Specified by:
      getOrigin in interface io.micronaut.http.HttpHeaders