Module io.helidon.webclient
Package io.helidon.webclient

Interface WebClientRequestHeaders

All Superinterfaces:
Headers, Iterable<Map.Entry<String,List<String>>>, Parameters
public interface WebClientRequestHeaders extends Headers
Headers that can be modified (until request is sent) for outbound request.

  • Method Details

    • unsetHeader

      WebClientRequestHeaders unsetHeader(String name)
      Remove a header if set.
      Parameters:
      name - header name
      Returns:
      updated headers instance

    • addCookie

      WebClientRequestHeaders addCookie(String name, String value)
      Add a cookie to the request.
      Parameters:
      name - cookie name
      value - cookie value
      Returns:
      updated headers instance

    • contentType

      WebClientRequestHeaders contentType(MediaType contentType)
      Set a content type. This method is optional if you use a writer for a specific type. If the content type is explicitly defined, writer will NOT override it.
      Parameters:
      contentType - content type of the request
      Returns:
      updated headers instance

    • contentLength

      WebClientRequestHeaders contentLength(long length)
      Set a content length. This method is optional. Use only when you know the exact length of entity in bytes.
      Parameters:
      length - content length of entity
      Returns:
      updated headers instance

    • addAccept

      WebClientRequestHeaders addAccept(MediaType mediaType)
      Add accepted MediaType. Supports quality factor and wildcards. Ordered by invocation order.
      Parameters:
      mediaType - media type to accept, with optional quality factor
      Returns:
      updated headers instance

    • ifModifiedSince

      WebClientRequestHeaders ifModifiedSince(ZonedDateTime time)
      Sets Http.Header.IF_MODIFIED_SINCE header to specific time.
      Parameters:
      time - zoned date time
      Returns:
      updated headers instance

    • ifUnmodifiedSince

      WebClientRequestHeaders ifUnmodifiedSince(ZonedDateTime time)
      Sets Http.Header.IF_UNMODIFIED_SINCE header to specific time.
      Parameters:
      time - zoned date time
      Returns:
      updated headers instance

    • ifNoneMatch

      WebClientRequestHeaders ifNoneMatch(String... etags)
      Sets Http.Header.IF_NONE_MATCH header to specific etags.
      Parameters:
      etags - etags
      Returns:
      updated headers instance

    • ifMatch

      WebClientRequestHeaders ifMatch(String... etags)
      Sets Http.Header.IF_MATCH header to specific etags.
      Parameters:
      etags - etags
      Returns:
      updated headers instance

    • ifRange

      WebClientRequestHeaders ifRange(ZonedDateTime time)
      Sets Http.Header.IF_RANGE header to specific time.
      Parameters:
      time - zoned date time
      Returns:
      updated headers instance

    • ifRange

      WebClientRequestHeaders ifRange(String etag)
      Sets Http.Header.IF_RANGE header to specific etag.
      Parameters:
      etag - etag
      Returns:
      updated headers instance

    • acceptedTypes

      List<MediaType> acceptedTypes()
      Returns a list of acceptedTypes ("Accept" header) content types in quality factor order. Never null.
      Returns:
      A list of acceptedTypes media types.

    • contentType

      MediaType contentType()
      Returns content type of the request. If there is no explicit content set, then MediaType.WILDCARD is returned.
      Returns:
      content type of the request

    • contentLength

      Optional<Long> contentLength()
      Returns content length if known.
      Returns:
      content length

    • ifModifiedSince

      Optional<ZonedDateTime> ifModifiedSince()
      Returns value of header "If-Modified-Since".
      Returns:
      IF_MODIFIED_SINCE header value.

    • ifUnmodifiedSince

      Optional<ZonedDateTime> ifUnmodifiedSince()
      Returns value of header "If-Unmodified-Since".
      Returns:
      IF_UNMODIFIED_SINCE header value.

    • ifNoneMatch

      List<String> ifNoneMatch()
      Returns value of header "If-None-Match". Empty List is returned if this header is not set.
      Returns:
      A list of etags.

    • ifMatch

      List<String> ifMatch()
      Returns value of header "If-Match". Empty List is returned if this header is not set.
      Returns:
      A list of etags.

    • ifRangeDate

      Optional<ZonedDateTime> ifRangeDate()
      Returns value of header "If-Range" as a ZonedDateTime.
      Returns:
      formatted header IF_RANGE as ZonedDateTime

    • ifRangeString

      Optional<String> ifRangeString()
      Returns value of header "If-Range" as a String.
      Returns:
      formatted header IF_RANGE as String

    • clear

      void clear()
      Clears all currently set headers.

    • putAll

      WebClientRequestHeaders putAll(Parameters parameters)
      Description copied from interface: Parameters
      Copies all of the mappings from the specified parameters to this instance replacing values of existing associations (optional operation).
      Specified by:
      putAll in interface Parameters
      Parameters:
      parameters - to copy.
      Returns:
      this instance of Parameters

    • add

      WebClientRequestHeaders add(String key, String... values)
      Description copied from interface: Parameters
      Adds specified values to association with the specified key (optional operation). If parameters doesn't contains mapping, new mapping is created.
      Specified by:
      add in interface Parameters
      Parameters:
      key - key with which the specified value is to be associated
      values - value to be add to association with the specified key
      Returns:
      this instance of Parameters

    • add

      WebClientRequestHeaders add(String key, Iterable<String> values)
      Description copied from interface: Parameters
      Adds specified values to association with the specified key (optional operation). If parameters doesn't contains mapping, new mapping is created.
      Specified by:
      add in interface Parameters
      Parameters:
      key - key with which the specified value is to be associated
      values - value to be add to association with the specified key. If null then noting will be add.
      Returns:
      this instance of Parameters

    • addAll

      WebClientRequestHeaders addAll(Parameters parameters)
      Description copied from interface: Parameters
      Copies all of the mappings from the specified parameters to this instance adding values to existing associations (optional operation).
      Specified by:
      addAll in interface Parameters
      Parameters:
      parameters - to copy.
      Returns:
      this instance of Parameters