object Header
- Alphabetic
- By Inheritance
- Header
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class Accept(mimeTypes: NonEmptyChunk[MediaTypeWithQFactor]) extends Header with Product with Serializable
- sealed trait AcceptEncoding extends Header
Represents an AcceptEncoding header value.
- sealed trait AcceptLanguage extends Header
The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
- final case class AcceptPatch(mediaTypes: NonEmptyChunk[MediaType]) extends Header with Product with Serializable
The Accept-Patch response HTTP header advertises which media-type the server is able to understand in a PATCH request.
- sealed trait AcceptRanges extends Header
The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads.
The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads. The value of this field indicates the unit that can be used to define a range. By default the RFC 7233 specification supports only 2 possible values.
- sealed trait AccessControlAllowCredentials extends Header
- sealed trait AccessControlAllowHeaders extends Header
- sealed trait AccessControlAllowMethods extends Header
- sealed trait AccessControlAllowOrigin extends Header
The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.
The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.
For requests without credentials, the literal value "*" can be specified as a wildcard; the value tells browsers to allow requesting code from any origin to access the resource. Attempting to use the wildcard with credentials results in an error.
<origin> Specifies an origin. Only a single origin can be specified. If the server supports clients from multiple origins, it must return the origin for the specific client making the request.
null Specifies the origin "null".
- sealed trait AccessControlExposeHeaders extends Header
The Access-Control-Expose-Headers response header allows a server to indicate which response headers should be made available to scripts running in the browser, in response to a cross-origin request.
- final case class AccessControlMaxAge(duration: zio.Duration) extends Header with Product with Serializable
The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.
The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.
Maximum number of seconds the results can be cached, as an unsigned non-negative integer. Firefox caps this at 24 hours (86400 seconds). Chromium (prior to v76) caps at 10 minutes (600 seconds). Chromium (starting in v76) caps at 2 hours (7200 seconds). The default value is 5 seconds.
- final case class AccessControlRequestHeaders(values: NonEmptyChunk[String]) extends Header with Product with Serializable
- final case class AccessControlRequestMethod(method: Method) extends Header with Product with Serializable
- final case class Age(duration: zio.Duration) extends Header with Product with Serializable
Age header value.
- final case class Allow(methods: NonEmptyChunk[Method]) extends Header with Product with Serializable
The Allow header must be sent if the server responds with a 405 Method Not Allowed status code to indicate which request methods can be used.
- sealed trait AuthenticationScheme extends AnyRef
- sealed trait Authorization extends Header
Authorization header value.
Authorization header value.
The Authorization header value contains one of the auth schemes
- sealed trait CacheControl extends Header
CacheControl header value.
- sealed trait Connection extends Header
Connection header value.
- final case class ContentBase(uri: URI) extends Header with Product with Serializable
- sealed trait ContentDisposition extends Header
- sealed trait ContentEncoding extends Header
- sealed trait ContentLanguage extends Header
- final case class ContentLength(length: Long) extends Header with Product with Serializable
The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.
- final case class ContentLocation(value: URI) extends Header with Product with Serializable
- final case class ContentMd5(value: String) extends Header with Product with Serializable
- sealed trait ContentRange extends Header
- sealed trait ContentSecurityPolicy extends Header
- sealed trait ContentTransferEncoding extends Header
- final case class ContentType(mediaType: MediaType, boundary: Option[Boundary] = None, charset: Option[Charset] = None) extends Header with Product with Serializable
- final case class Cookie(value: NonEmptyChunk[Cookie.Request]) extends Header with Product with Serializable
- final case class Custom(customName: CharSequence, value: CharSequence) extends Header with Product with Serializable
- sealed trait DNT extends Header
- final case class Date(value: ZonedDateTime) extends Header with Product with Serializable
- sealed trait ETag extends Header
- sealed trait Expect extends Header
The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully.
The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully. There is only one defined expectation: 100-continue
- final case class Expires(value: ZonedDateTime) extends Header with Product with Serializable
- final case class From(email: String) extends Header with Product with Serializable
From header value.
- sealed trait HeaderType extends AnyRef
- final case class Host(hostAddress: String, port: Option[Int] = None) extends Header with Product with Serializable
- sealed trait IfMatch extends Header
- final case class IfModifiedSince(value: ZonedDateTime) extends Header with Product with Serializable
- sealed trait IfNoneMatch extends Header
- sealed trait IfRange extends Header
The If-Range HTTP request header makes a range request conditional.
The If-Range HTTP request header makes a range request conditional. Possible values:
- <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
- <etag> a string of ASCII characters placed between double quotes (Like "675af34563dc-tr34"). A weak entity tag (one prefixed by W/) must not be used in this header.
- final case class IfUnmodifiedSince(value: ZonedDateTime) extends Header with Product with Serializable
- final case class LastModified(value: ZonedDateTime) extends Header with Product with Serializable
- final case class Location(url: URL) extends Header with Product with Serializable
Location header value.
- final case class MaxForwards(value: Int) extends Header with Product with Serializable
Max-Forwards header value
- sealed trait Origin extends Header
Origin header value.
- sealed trait Pragma extends Header
Pragma header value.
- final case class ProxyAuthenticate(scheme: AuthenticationScheme, realm: Option[String]) extends Header with Product with Serializable
The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server.
The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server. It authenticates the request to the proxy server, allowing it to transmit the request further.
- scheme
Authentication type
- realm
A description of the protected area, the realm. If no realm is specified, clients often display a formatted host name instead.
- final case class ProxyAuthorization(authenticationScheme: AuthenticationScheme, credential: String) extends Header with Product with Serializable
Proxy-Authorization: <type> <credentials>
Proxy-Authorization: <type> <credentials>
<type> - AuthenticationScheme
<credentials> - The resulting string is base64 encoded
Example
Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
- sealed trait Range extends Header
- final case class Referer(url: URL) extends Header with Product with Serializable
The Referer HTTP request header contains the absolute or partial address from which a resource has been requested.
The Referer HTTP request header contains the absolute or partial address from which a resource has been requested. The Referer header allows a server to identify referring pages that people are visiting from or where requested resources are being used. This data can be used for analytics, logging, optimized caching, and more.
When you click a link, the Referer contains the address of the page that includes the link. When you make resource requests to another domain, the Referer contains the address of the page that uses the requested resource.
The Referer header can contain an origin, path, and querystring, and may not contain URL fragments (i.e. #section) or username:password information. The request's referrer policy defines the data that can be included. See Referrer-Policy for more information and examples.
- sealed trait RetryAfter extends Header
- final case class SecWebSocketAccept(hashedKey: String) extends Header with Product with Serializable
- sealed trait SecWebSocketExtensions extends Header
- final case class SecWebSocketKey(base64EncodedKey: String) extends Header with Product with Serializable
- final case class SecWebSocketLocation(url: URL) extends Header with Product with Serializable
- final case class SecWebSocketOrigin(url: URL) extends Header with Product with Serializable
- final case class SecWebSocketProtocol(subProtocols: NonEmptyChunk[String]) extends Header with Product with Serializable
- final case class SecWebSocketVersion(version: Int) extends Header with Product with Serializable
- final case class Server(name: String) extends Header with Product with Serializable
Server header value.
- final case class SetCookie(value: Cookie.Response) extends Header with Product with Serializable
- sealed trait Te extends Header
- final case class Trailer(header: String) extends Header with Product with Serializable
Trailer header value.
- sealed trait TransferEncoding extends Header
- sealed trait Upgrade extends Header
- final case class UpgradeInsecureRequests() extends Header with Product with Serializable
- sealed trait UserAgent extends Header
- sealed trait Vary extends Header
Vary header value.
- sealed trait Via extends Header
- sealed trait WWWAuthenticate extends Header
- final case class Warning(code: Int, agent: String, text: String, date: Option[ZonedDateTime] = None) extends Header with Product with Serializable
- sealed trait XFrameOptions extends Header
- final case class XRequestedWith(value: String) extends Header with Product with Serializable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object Accept extends HeaderType with Serializable
- object AcceptEncoding extends HeaderType
- object AcceptLanguage extends HeaderType
- object AcceptPatch extends HeaderType with Serializable
- object AcceptRanges extends HeaderType
- object AccessControlAllowCredentials extends HeaderType
- object AccessControlAllowHeaders extends HeaderType
The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.
- object AccessControlAllowMethods extends HeaderType
- object AccessControlAllowOrigin extends HeaderType
- object AccessControlExposeHeaders extends HeaderType
- object AccessControlMaxAge extends HeaderType with Serializable
- object AccessControlRequestHeaders extends HeaderType with Serializable
The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()).
The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()). The complementary server-side header of Access-Control-Allow-Headers will answer this browser-side header.
- object AccessControlRequestMethod extends HeaderType with Serializable
- object Age extends HeaderType with Serializable
- object Allow extends HeaderType with Serializable
- object AuthenticationScheme
- object Authorization extends HeaderType
- object CacheControl extends HeaderType
- object Connection extends HeaderType
- object ContentBase extends HeaderType with Serializable
- object ContentDisposition extends HeaderType
- object ContentEncoding extends HeaderType
- object ContentLanguage extends HeaderType
- object ContentLength extends HeaderType with Serializable
- object ContentLocation extends HeaderType with Serializable
- object ContentMd5 extends HeaderType with Serializable
- object ContentRange extends HeaderType
- object ContentSecurityPolicy extends HeaderType
- object ContentTransferEncoding extends HeaderType
- object ContentType extends HeaderType with Serializable
- object Cookie extends HeaderType with Serializable
The Cookie HTTP request header contains stored HTTP cookies associated with the server.
- object DNT extends HeaderType
- object Date extends HeaderType with Serializable
The Date general HTTP header contains the date and time at which the message originated.
- object ETag extends HeaderType
- object Expect extends HeaderType
- object Expires extends HeaderType with Serializable
The Expires HTTP header contains the date/time after which the response is considered expired.
The Expires HTTP header contains the date/time after which the response is considered expired.
Invalid expiration dates with value 0 represent a date in the past and mean that the resource is already expired.
Expires: <Date>
Date: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
Example:
Expires: Wed, 21 Oct 2015 07:28:00 GMT
- object From extends HeaderType with Serializable
- object HeaderType
- object Host extends HeaderType with Serializable
- object IfMatch extends HeaderType
- object IfModifiedSince extends HeaderType with Serializable
- object IfNoneMatch extends HeaderType
- object IfRange extends HeaderType
- object IfUnmodifiedSince extends HeaderType with Serializable
If-Unmodified-Since request header makes the request for the resource conditional: the server will send the requested resource or accept it in the case of a POST or another non-safe method only if the resource has not been modified after the date specified by this HTTP header.
- object LastModified extends HeaderType with Serializable
- object Location extends HeaderType with Serializable
- object MaxForwards extends HeaderType with Serializable
- object Origin extends HeaderType
- object Pragma extends HeaderType
- object ProxyAuthenticate extends HeaderType with Serializable
- object ProxyAuthorization extends HeaderType with Serializable
The HTTP Proxy-Authorization request header contains the credentials to authenticate a user agent to a proxy server, usually after the server has responded with a 407 Proxy Authentication Required status and the Proxy-Authenticate header.
- object Range extends HeaderType
- object Referer extends HeaderType with Serializable
- object RetryAfter extends HeaderType
The RetryAfter HTTP header contains the date/time after which to retry
The RetryAfter HTTP header contains the date/time after which to retry
RetryAfter: <Date>
Date: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
Example:
Expires: Wed, 21 Oct 2015 07:28:00 GMT
Or RetryAfter the delay seconds.
- object SecWebSocketAccept extends HeaderType with Serializable
The Sec-WebSocket-Accept header is used in the websocket opening handshake.
The Sec-WebSocket-Accept header is used in the websocket opening handshake. It would appear in the response headers. That is, this is header is sent from server to client to inform that server is willing to initiate a websocket connection.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Accept
- object SecWebSocketExtensions extends HeaderType
The Sec-WebSocket-Extensions header is used in the WebSocket handshake.
The Sec-WebSocket-Extensions header is used in the WebSocket handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use during the connection.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Extensions
- object SecWebSocketKey extends HeaderType with Serializable
The Sec-WebSocket-Key header is used in the WebSocket handshake.
The Sec-WebSocket-Key header is used in the WebSocket handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g. HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Key
- object SecWebSocketLocation extends HeaderType with Serializable
- object SecWebSocketOrigin extends HeaderType with Serializable
The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser.
The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser. The server is informed of the script origin generating the WebSocket connection request.
- object SecWebSocketProtocol extends HeaderType with Serializable
The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake.
The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Protocol
- object SecWebSocketVersion extends HeaderType with Serializable
The Sec-WebSocket-Version header field is used in the WebSocket opening handshake.
The Sec-WebSocket-Version header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Version
- object Server extends HeaderType with Serializable
- object SetCookie extends HeaderType with Serializable
- object Te extends HeaderType
- object Trailer extends HeaderType with Serializable
- object TransferEncoding extends HeaderType
- object Upgrade extends HeaderType
- object UpgradeInsecureRequests extends HeaderType with Serializable
The HTTP Upgrade-Insecure-Requests request header sends a signal to the server expressing the client's preference for an encrypted and authenticated response.
- object UserAgent extends HeaderType
The "User-Agent" header field contains information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use
- object Vary extends HeaderType
- object Via extends HeaderType
The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers.
The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers. It is used for tracking message forwards, avoiding request loops, and identifying the protocol capabilities of senders along the request/response chain
- object WWWAuthenticate extends HeaderType
- object Warning extends HeaderType with Serializable
- object XFrameOptions extends HeaderType
- object XRequestedWith extends HeaderType with Serializable