package headers
- Source
- package.scala
- Alphabetic
- By Inheritance
- headers
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class Accept(values: NonEmptyList[MediaRangeAndQValue]) extends Product with Serializable
- 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 [https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.3 RFC-7231].
- final case class Accept-Encoding(values: NonEmptyList[ContentCoding]) extends Product with Serializable
- 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.
- final case class Accept-Patch(values: NonEmptyList[MediaType]) extends Product with Serializable
- final case class Accept-Post(values: List[MediaType]) extends Product with Serializable
- final case class Accept-Ranges(rangeUnits: List[RangeUnit]) extends Product with Serializable
- final case class Access-Control-Allow-Credentials() extends Product with Serializable
- final case class Access-Control-Allow-Headers(values: NonEmptyList[CIString]) extends Product with Serializable
- final case class Access-Control-Allow-Methods(methods: Set[Method]) extends Product with Serializable
The
Access-Control-Allow-Methods
header. - final case class Access-Control-Expose-Headers(values: NonEmptyList[CIString]) extends Product with Serializable
- trait Access-Control-Max-Age extends AnyRef
The
Access-Control-Max-Age
header. - final case class Access-Control-Request-Method(method: Method) extends Product with Serializable
- 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
- 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.
- final case class Authorization(credentials: Credentials) extends Product with Serializable
- final case class Cache-Control(values: NonEmptyList[CacheDirective]) extends Product with Serializable
- final case class Connection(values: NonEmptyList[CIString]) extends Product with Serializable
- final case class Content-Disposition(dispositionType: String, parameters: Map[CIString, String]) extends Product with Serializable
- final case class Content-Encoding(contentCoding: ContentCoding) extends Product with Serializable
- final case class Content-Language(values: NonEmptyList[LanguageTag]) extends Product with Serializable
- 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 ofBigInt
.- length
the length
- 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
- final case class Content-Range(unit: RangeUnit, range: SubRange, length: Option[Long]) extends Product with Serializable
- 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.
- final case class Cookie(values: NonEmptyList[RequestCookie]) extends Product with Serializable
- sealed abstract class Cross-Origin-Resource-Policy extends Product with Serializable
This response header conveys a desire that the browser blocks no-cors cross-origin/cross-site requests to the given resource
This response header conveys a desire that the browser blocks no-cors cross-origin/cross-site requests to the given resource
- sealed abstract class DNT extends Product with Serializable
- final case class Date(date: HttpDate) extends Product with Serializable
- final case class Deprecation(date: HttpDate) extends Product with Serializable
- final case class ETag(tag: EntityTag) extends Product with Serializable
- 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
- expirationDate
the date of expiration. The RFC has a warning, that using large values can cause problems due to integer or clock overflows.
- final case class Forwarded(values: NonEmptyList[Element]) extends Product with Serializable
- 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.
- 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.
- 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).
- 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. }}
- final case class If-None-Match(tags: Option[NonEmptyList[EntityTag]]) extends Product with Serializable
- sealed abstract class If-Range extends Product with Serializable
- final case class If-Unmodified-Since(date: HttpDate) extends Product with Serializable
- sealed abstract case class Keep-Alive extends Product with Serializable
- final case class Last-Event-Id(id: EventId) extends Product with Serializable
- 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.
- final case class Link(values: NonEmptyList[LinkValue]) extends Product with Serializable
- 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
- final case class Location(uri: Uri) extends Product with Serializable
- 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.
- final case class MediaRangeAndQValue(mediaRange: MediaRange, qValue: QValue = QValue.One) extends Renderable with Product with Serializable
- sealed abstract class Origin extends AnyRef
- 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
- final case class Proxy-Authorization(credentials: Credentials) extends Product with Serializable
- final case class Range(unit: RangeUnit, ranges: NonEmptyList[SubRange]) extends Product with Serializable
- final case class Referer(uri: Uri) extends Product with Serializable
- 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.
- final case class Sec-WebSocket-Accept(hashedKey: ByteVector) extends Product with Serializable
- final case class Sec-WebSocket-Key(hashedKey: ByteVector) extends Product with Serializable
- final case class Sec-WebSocket-Version extends Product with Serializable
- final case class Server(product: ProductId, rest: List[ProductIdOrComment]) extends Product with Serializable
Server header https://datatracker.ietf.org/doc/html/rfc7231#section-7.4.2
- final case class Set-Cookie(cookie: ResponseCookie) extends Product with Serializable
- final case class SourceMap(uri: Uri) extends Product with Serializable
A Response header that _links generated code to a source map, enabling the browser to reconstruct the original source and present the reconstructed original in the debugger_.
A Response header that _links generated code to a source map, enabling the browser to reconstruct the original source and present the reconstructed original in the debugger_.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/SourceMap
- uri
A relative (to the request URL) or absolute URL pointing to a source map file.
- sealed abstract case class Strict-Transport-Security extends Product with Serializable
- final case class Sunset(date: HttpDate) extends Product with Serializable
- final case class Trailer(headers: NonEmptyList[CIString]) extends Product with Serializable
- See also
- final case class Transfer-Encoding(values: NonEmptyList[TransferCoding]) extends Product with Serializable
- final case class Upgrade(values: NonEmptyList[Protocol]) extends Product with Serializable
- sealed abstract class Upgrade-Insecure-Requests extends AnyRef
- final case class User-Agent(product: ProductId, rest: List[ProductIdOrComment]) extends Product with Serializable
User-Agent header RFC-7231 Section 5.5.3
- final case class WWW-Authenticate(values: NonEmptyList[Challenge]) extends Product with Serializable
- final case class X-B3-Flags(flags: Set[Flag]) extends Product with Serializable
- final case class X-B3-ParentSpanId(id: Long) extends Product with Serializable
- final case class X-B3-Sampled(sampled: Boolean) extends Product with Serializable
- final case class X-B3-SpanId(id: Long) extends Product with Serializable
- final case class X-B3-TraceId(idMostSigBits: Long, idLeastSigBits: Option[Long]) extends Product with Serializable
- sealed trait X-Content-Type-Options extends AnyRef
- final case class X-Forwarded-For(values: NonEmptyList[Option[IpAddress]]) extends Product with Serializable
- final case class X-Forwarded-Proto(scheme: Scheme) extends AnyVal with Product with Serializable
Deprecated Type Members
- type AgentComment = ProductComment
- Annotations
- @deprecated
- Deprecated
(Since version 0.22.0-M1) Deprecated in favor of ProductComment
- type AgentProduct = ProductId
- Annotations
- @deprecated
- Deprecated
(Since version 0.22.0-M1) Deprecated in favor of ProductId
- type AgentToken = ProductIdOrComment
- Annotations
- @deprecated
- Deprecated
(Since version 0.22.0-M1) Deprecated in favor of ProductIdOrComment
Value Members
- object Accept extends Serializable
- object Accept-Charset extends Serializable
- object Accept-Encoding extends Serializable
- object Accept-Language extends Serializable
- object Accept-Patch extends Serializable
- object Accept-Post extends Serializable
- object Accept-Ranges extends Serializable
- object Access-Control-Allow-Credentials extends Serializable
- object Access-Control-Allow-Headers extends Serializable
- object Access-Control-Allow-Methods extends Serializable
- object Access-Control-Expose-Headers extends Serializable
- object Access-Control-Max-Age
- object Access-Control-Request-Method extends Serializable
- object Age extends Serializable
- object Allow extends Serializable
- object Authorization extends Serializable
- object Cache-Control extends HeaderCompanion[Cache-Control] with Serializable
- object Connection extends Serializable
- object Content-Disposition extends Serializable
- object Content-Encoding extends Serializable
- object Content-Language extends Serializable
- object Content-Length extends Serializable
- object Content-Location extends Serializable
- object Content-Range extends Serializable
- object Content-Type extends Serializable
- object Cookie extends Serializable
- object Cross-Origin-Resource-Policy extends Serializable
- object DNT extends Serializable
- object Date extends Serializable
- object Deprecation extends Serializable
Deprecation Header
Deprecation Header
https://greenbytes.de/tech/webdav/draft-ietf-httpapi-deprecation-header-latest.html#the-deprecation-http-response-header-field
- object ETag extends Serializable
- object Expires extends Serializable
- object Forwarded extends ForwardedRenderers with Serializable
- object Host extends HeaderCompanion[Host] with Serializable
- object Idempotency-Key extends Serializable
- object If-Match extends Serializable
- object If-Modified-Since extends Serializable
- 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
- object If-Range extends Serializable
- object If-Unmodified-Since extends Serializable
- object Keep-Alive extends Serializable
- object Last-Event-Id extends Serializable
- object Last-Modified extends HeaderCompanion[Last-Modified] with Serializable
- object Link extends Serializable
- object Location extends Serializable
- object Max-Forwards extends HeaderCompanion[Max-Forwards] with Serializable
- object MediaRangeAndQValue extends Serializable
- object Origin
- object Proxy-Authenticate extends Serializable
- 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
- object Range extends Serializable
- object Referer extends HeaderCompanion[Referer] with Serializable
- object Retry-After extends Serializable
- object Sec-WebSocket-Accept extends Serializable
- object Sec-WebSocket-Key extends Serializable
- object Sec-WebSocket-Version extends Serializable
- object Server extends HeaderCompanion[Server] with Serializable
- object Set-Cookie extends Serializable
- object SourceMap extends HeaderCompanion[SourceMap] with Serializable
- object Strict-Transport-Security extends Serializable
Defined by https://datatracker.ietf.org/doc/html/rfc6797
- object Sunset extends Serializable
Sunset Header - RFC 8594
Sunset Header - RFC 8594
https://www.rfc-editor.org/rfc/rfc8594
- object Trailer extends Serializable
- object Transfer-Encoding extends Serializable
- object Upgrade extends HeaderCompanion[Upgrade] with Serializable
- case object Upgrade-Insecure-Requests extends Upgrade-Insecure-Requests with Product with Serializable
- object User-Agent extends Serializable
- object WWW-Authenticate extends Serializable
- object X-B3-Flags extends Serializable
- object X-B3-ParentSpanId extends Serializable
- object X-B3-Sampled extends Serializable
- object X-B3-SpanId extends Serializable
- object X-B3-TraceId extends Serializable
- object X-Content-Type-Options extends HeaderCompanion[X-Content-Type-Options]
- object X-Forwarded-For extends Serializable
- object X-Forwarded-Proto extends Serializable