Packages

p

org.http4s

headers

package headers

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. headers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Accept(values: NonEmptyList[MediaRangeAndQValue]) extends Product with Serializable
  2. final case class Accept-Charset(values: NonEmptyList[CharsetRange]) extends Product with Serializable 

    The "Accept-Charset" header field can be sent by a user agent to
indicate what charsets are acceptable in textual response content.
This field allows user agents capable of understanding more

    From [http//tools.ietf.org/html/rfc7231#section-5.3.3 RFC-7231].

  3. final case class Accept-Encoding(values: NonEmptyList[ContentCoding]) extends Product with Serializable
  4. final case class Accept-Language(values: NonEmptyList[LanguageTag]) extends Product with Serializable

    Request header used to indicate which natural language would be preferred for the response to be translated into.

    Request header used to indicate which natural language would be preferred for the response to be translated into.

    RFC-7231 Section 5.3.5

  5. final case class Accept-Patch(values: NonEmptyList[MediaType]) extends Product with Serializable
  6. final case class Accept-Post(values: List[MediaType]) extends Product with Serializable
  7. final case class Accept-Ranges extends Product with Serializable
  8. final case class Access-Control-Allow-Credentials() extends Product with Serializable
  9. final case class Access-Control-Allow-Headers(values: List[CIString]) extends Product with Serializable
  10. final case class Access-Control-Expose-Headers(values: List[CIString]) extends Product with Serializable
  11. trait Access-Control-Max-Age extends AnyRef

    The Access-Control-Max-Age header.

  12. final case class Access-Control-Request-Method(method: Method) extends Product with Serializable
  13. final case class Age extends Product with Serializable

    Constructs an Age header.

    Constructs an Age header.

    The value of this field is a positive number of seconds (in decimal) with an estimate of the amount of time since the response

  14. final case class Allow(methods: Set[Method]) extends Product with Serializable

    A Response header that lists the methods that are supported by the target resource.

    A Response header that lists the methods that are supported by the target resource. Must be attached to responses with status 405 Not Allowed, though in practice not all servers honor this.

    RFC-7231 Section 7.4.1 Allow

  15. final case class Authorization(credentials: Credentials) extends Product with Serializable
  16. final case class Cache-Control(values: NonEmptyList[CacheDirective]) extends Product with Serializable
  17. final case class Connection(values: NonEmptyList[CIString]) extends Product with Serializable
  18. final case class Content-Disposition(dispositionType: String, parameters: Map[CIString, String]) extends Product with Serializable
  19. final case class Content-Encoding(contentCoding: ContentCoding) extends Product with Serializable
  20. final case class Content-Language(values: NonEmptyList[LanguageTag]) extends Product with Serializable
  21. final case class Content-Length(length: Long) extends Product with Serializable

    Constructs a Content-Length header.

    Constructs a Content-Length header.

    The HTTP RFCs do not specify a maximum length. We have decided that Long.MaxValue bytes ought to be good enough for anybody in order to avoid the irritations of BigInt.

    length

    the length

  22. final case class Content-Location(uri: Uri) extends Product with Serializable 

    The "Content-Location" header field references a URI that can be used
as an identifier for a specific resource corresponding to the
representation in this message's payload

    RFC-7231 Section 3.1.4.2

  23. final case class Content-Range(unit: RangeUnit, range: SubRange, length: Option[Long]) extends Product with Serializable
  24. final case class Content-Type extends Product with Serializable 

    The "Content-Type" header field indicates the media type of the
associated representation: either the representation enclosed in the
message payload or the selected representation, as determined by the
message semantics.

    RFC-7231

  25. final case class Cookie(values: NonEmptyList[RequestCookie]) extends Product with Serializable
  26. sealed abstract class DNT extends Product with Serializable
  27. final case class Date(date: HttpDate) extends Product with Serializable
  28. final case class ETag(tag: EntityTag) extends Product with Serializable
  29. final case class Expires(expirationDate: HttpDate) extends Product with Serializable

    A Response header that _gives the date/time after which the response is considered stale_.

    A Response header that _gives the date/time after which the response is considered stale_.

    The HTTP RFCs indicate that Expires should be in the range of now to 1 year in the future. However, it is a usual practice to set it to the past of far in the future Thus any instant is in practice allowed

    RFC-7234 Section 5.3

    expirationDate

    the date of expiration. The RFC has a warning, that using large values can cause problems due to integer or clock overflows.

  30. final case class Forwarded(values: NonEmptyList[Element]) extends Product with Serializable
  31. final case class Host(host: String, port: Option[Int] = None) extends Product with Serializable

    A Request header, that provides the host and port information

    A Request header, that provides the host and port information

    The "Host" header field in a request provides the host and port
information from the target URI, enabling the origin server to
distinguish among resources while servicing requests for multiple
host names on a single IP address.

    This header was mandatory in version 1.1 of the Http protocol.

    RFC-7230 Section 5.4

  32. final case class Idempotency-Key(key: String) extends Product with Serializable

    Request header defines request to be idempotent used by client retry middleware.

    Request header defines request to be idempotent used by client retry middleware.

    idempotency-header

  33. final case class If-Match(tags: Option[NonEmptyList[EntityTag]]) extends Product with Serializable

    Request header to make the request conditional on the current contents of the origin server at the given target resource (URI).

    Request header to make the request conditional on the current contents of the origin server at the given target resource (URI).

    RFC-7232 Section 3.1

  34. final case class If-Modified-Since(date: HttpDate) extends Product with Serializable

    {{ The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value.

    {{ The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. }}

    RFC-7232

  35. final case class If-None-Match(tags: Option[NonEmptyList[EntityTag]]) extends Product with Serializable
  36. final case class If-Unmodified-Since(date: HttpDate) extends Product with Serializable
  37. sealed abstract case class Keep-Alive extends Product with Serializable
  38. final case class Last-Event-Id(id: EventId) extends Product with Serializable
  39. final case class Last-Modified(date: HttpDate) extends Product with Serializable

    Response header that indicates the time at which the server believes the entity was last modified.

    Response header that indicates the time at which the server believes the entity was last modified.

    RFC-7232

  40. final case class Link(values: NonEmptyList[LinkValue]) extends Product with Serializable
  41. final case class LinkValue(uri: Uri, rel: Option[String] = None, rev: Option[String] = None, title: Option[String] = None, type: Option[MediaRange] = None) extends Renderable with Product with Serializable
  42. final case class Location(uri: Uri) extends Product with Serializable
  43. sealed abstract case class Max-Forwards extends Product with Serializable

    Request header, used with the TRACE and OPTION request methods, that gives an upper bound on how many times the request can be forwarded by a proxy before it is rejected.

    Request header, used with the TRACE and OPTION request methods, that gives an upper bound on how many times the request can be forwarded by a proxy before it is rejected.

    RFC-7231

  44. final case class MediaRangeAndQValue(mediaRange: MediaRange, qValue: QValue = QValue.One) extends Renderable with Product with Serializable
  45. sealed abstract class Origin extends AnyRef
  46. final case class Proxy-Authenticate(values: NonEmptyList[Challenge]) extends Product with Serializable 

    The "Proxy-Authenticate" header field consists of at least one
challenge that indicates the authentication scheme(s) and parameters
applicable to the proxy for this effective request URI...

    From RFC-7235

  47. final case class Proxy-Authorization(credentials: Credentials) extends Product with Serializable
  48. final case class Range(unit: RangeUnit, ranges: NonEmptyList[SubRange]) extends Product with Serializable
  49. final case class Referer(uri: Uri) extends Product with Serializable
  50. sealed abstract case class Retry-After extends Product with Serializable

    Response header, used by the server to indicate to the user-agent how long it has to wait before it can try again with a follow-up request.

    Response header, used by the server to indicate to the user-agent how long it has to wait before it can try again with a follow-up request.

    RFC-7231 Section 7.1.3

  51. final class Sec-WebSocket-Accept extends AnyRef
  52. final class Sec-WebSocket-Key extends AnyRef
  53. final case class Sec-WebSocket-Version extends Product with Serializable
  54. final case class Server(product: ProductId, rest: List[ProductIdOrComment]) extends Product with Serializable

    Server header https://tools.ietf.org/html/rfc7231#section-7.4.2

  55. final case class Set-Cookie(cookie: ResponseCookie) extends Product with Serializable
  56. sealed abstract case class Strict-Transport-Security extends Product with Serializable
  57. final case class Transfer-Encoding(values: NonEmptyList[TransferCoding]) extends Product with Serializable
  58. final case class Upgrade(values: NonEmptyList[Protocol]) extends Product with Serializable
  59. final case class User-Agent(product: ProductId, rest: List[ProductIdOrComment]) extends Product with Serializable

    User-Agent header RFC-7231 Section 5.5.3

  60. final case class WWW-Authenticate(values: NonEmptyList[Challenge]) extends Product with Serializable
  61. final case class X-B3-Flags(flags: Set[Flag]) extends Product with Serializable
  62. final case class X-B3-ParentSpanId(id: Long) extends Product with Serializable
  63. final case class X-B3-Sampled(sampled: Boolean) extends Product with Serializable
  64. final case class X-B3-SpanId(id: Long) extends Product with Serializable
  65. final case class X-B3-TraceId(idMostSigBits: Long, idLeastSigBits: Option[Long]) extends Product with Serializable
  66. final case class X-Forwarded-For(values: NonEmptyList[Option[IpAddress]]) extends Product with Serializable
  67. final case class X-Forwarded-Proto(scheme: Scheme) extends AnyVal with Product with Serializable
  68. type AgentComment = ProductComment
    Annotations
    @deprecated
    Deprecated

    (Since version 0.22.0-M1) Deprecated in favor of ProductComment

  69. type AgentProduct = ProductId
    Annotations
    @deprecated
    Deprecated

    (Since version 0.22.0-M1) Deprecated in favor of ProductId

  70. type AgentToken = ProductIdOrComment
    Annotations
    @deprecated
    Deprecated

    (Since version 0.22.0-M1) Deprecated in favor of ProductIdOrComment

Value Members

  1. object Accept extends Serializable
  2. object Accept-Charset extends Serializable
  3. object Accept-Encoding extends Serializable
  4. object Accept-Language extends Serializable
  5. object Accept-Patch extends Serializable
  6. object Accept-Post extends Serializable
  7. object Accept-Ranges extends Serializable
  8. object Access-Control-Allow-Credentials extends Serializable
  9. object Access-Control-Allow-Headers extends Serializable
  10. object Access-Control-Expose-Headers extends Serializable
  11. object Access-Control-Max-Age
  12. object Access-Control-Request-Method extends Serializable
  13. object Age extends Serializable
  14. object Allow extends Serializable
  15. object Authorization extends Serializable
  16. object Cache-Control extends HeaderCompanion[Cache-Control] with Serializable
  17. object Connection extends Serializable
  18. object Content-Disposition extends Serializable
  19. object Content-Encoding extends Serializable
  20. object Content-Language extends Serializable
  21. object Content-Length extends Serializable
  22. object Content-Location extends Serializable
  23. object Content-Range extends Serializable
  24. object Content-Type extends Serializable
  25. object Cookie extends Serializable
  26. object DNT extends Serializable
  27. object Date extends Serializable
  28. object ETag extends Serializable
  29. object Expires extends Serializable
  30. object Forwarded extends ForwardedRenderers with Serializable
  31. object Host extends HeaderCompanion[Host] with Serializable
  32. object Idempotency-Key extends Serializable
  33. object If-Match extends Serializable
  34. object If-Modified-Since extends Serializable
  35. object If-None-Match extends Serializable 

    The "If-None-Match" header field makes the request method conditional
on a recipient cache or origin server either not having any current
representation of the target resource, when the field-value is "*",
or having a selected representation with an entity-tag that does not
match any of those listed in the field-value.

    From RFC-7232

  36. object If-Unmodified-Since extends Serializable
  37. object Keep-Alive extends Serializable
  38. object Last-Event-Id extends Serializable
  39. object Last-Modified extends HeaderCompanion[Last-Modified] with Serializable
  40. object Link extends Serializable
  41. object Location extends Serializable
  42. object Max-Forwards extends HeaderCompanion[Max-Forwards] with Serializable
  43. object MediaRangeAndQValue extends Serializable
  44. object Origin
  45. object Proxy-Authenticate extends Serializable
  46. object Proxy-Authorization extends Serializable 

    The "Proxy-Authorization" header field allows the client to identify
itself (or its user) to a proxy that requires authentication.

    From RFC-7235

  47. object Range extends Serializable
  48. object Referer extends HeaderCompanion[Referer] with Serializable
  49. object Retry-After extends Serializable
  50. object Sec-WebSocket-Accept
  51. object Sec-WebSocket-Key
  52. object Sec-WebSocket-Version extends Serializable
  53. object Server extends HeaderCompanion[Server] with Serializable
  54. object Set-Cookie extends Serializable
  55. object Strict-Transport-Security extends Serializable

    Defined by http://tools.ietf.org/html/rfc6797

  56. object Transfer-Encoding extends Serializable
  57. object Upgrade extends HeaderCompanion[Upgrade] with Serializable
  58. object User-Agent extends Serializable
  59. object WWW-Authenticate extends Serializable
  60. object X-B3-Flags extends Serializable
  61. object X-B3-ParentSpanId extends Serializable
  62. object X-B3-Sampled extends Serializable
  63. object X-B3-SpanId extends Serializable
  64. object X-B3-TraceId extends Serializable
  65. object X-Forwarded-For extends Serializable
  66. object X-Forwarded-Proto extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped