classafButter::HttpRequestHeaders

sys::Obj
  afButter::HttpRequestHeaders

A wrapper for HTTP request headers with accessors for commonly used headings. Set a value to null to remove it from the map. Backed by a case insensitive map.

@see http://en.wikipedia.org/wiki/List_of_HTTP_header_fields

accept

Source

QualityValues? accept

Content-Types that are acceptable for the response.

Example: Accept: audio/*; q=0.2, audio/basic

acceptEncoding

Source

QualityValues? acceptEncoding

List of acceptable encodings.

Example: Accept-Encoding: compress;q=0.5, gzip;q=1.0

acceptLanguage

Source

QualityValues? acceptLanguage

List of acceptable human languages for response.

Example: Accept-Language: da, en-gb;q=0.8, en;q=0.7

containsKey

Source

Bool containsKey(Str key)

Returns true if the given header has been set

contentLength

Source

Int? contentLength

The length of the request body in octets (8-bit bytes).

Example: Content-Length: 348

contentType

Source

MimeType? contentType

The MIME type of the body of the request (mainly used with POST and PUT requests).

Example: Content-Type: application/x-www-form-urlencoded

Source

Cookie[]? cookie

HTTP cookies previously sent by the server with Set-Cookie.

Example: Cookie: Version=1; Skin=new;

each

Source

Void each(|Str,Str c)

Iterates over the headers.

get

Source

@Operator
Str? get(Str name)

Simple setter for setting raw Str values.

host

Source

Str? host

The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.

Example: Host: www.alienfactory.co.uk:8069

ifModifiedSince

Source

DateTime? ifModifiedSince

Allows a 304 Not Modified to be returned if content is unchanged.

Example: If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT

ifNoneMatch

Source

Str? ifNoneMatch

Allows a 304 Not Modified to be returned if content is unchanged.

Example: If-None-Match: "737060cd8c284d8af7ad3082f209582d"

make

Source

new make([Str:Str]? headers := null)

Creates HttpRequestHeaders copying over values in the given map.

map

Source

Str:Str map()

Returns the case insensitive map that backs the headers.

origin

Source

Str? origin

Initiates a request for cross-origin resource sharing.

Example: Origin: http://www.example-social-network.com

referrer

Source

Uri? referrer

This is the address of the previous web page from which a link to the currently requested page was followed.

Example: Referer: http://en.wikipedia.org/wiki/Main_Page

set

Source

@Operator
Void set(Str name, Str value)

Simple getter for getting raw Str values.

toStr

Source

virtual override Str toStr()

userAgent

Source

Str? userAgent

The user agent string of the user agent.

Example: User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0

xForwardedFor

Source

Str[]? xForwardedFor

Identifies the originating IP address of a client connecting through an HTTP proxy.

Example: X-Forwarded-For: client, proxy1, proxy2

xRequestedWith

Source

Str? xRequestedWith

Mainly used to identify Ajax requests.

Example: X-Requested-With: XMLHttpRequest