Warning: This page pertains to an older version of BedSheet. Click here for the latest.

const mixinafBedSheet::HttpRequest

afBedSheet::HttpRequest

(Service) - An injectable const version of WebReq.

This class is proxied and will always refer to the current web request.

absUri

abstract Uri absUri()

The absolute request URI including the full authority and the query string.

@see web::WebReq.absUri

form

abstract [Str:Str]? form()

Get the key/value pairs of the form data. The request content is read and parsed using sys::Uri.decodeQuery.

If the request content type is not "application/x-www-form-urlencoded" this method returns null.

@see web::WebReq.form

headers

abstract HttpRequestHeaders headers()

Map of HTTP request headers. The map is readonly and case insensitive.

@see web::WebReq.headers

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

httpMethod

abstract Str httpMethod()

The HTTP request method in uppercase. Example: GET, POST, PUT.

@see web::WebReq.method

httpVersion

abstract Version httpVersion()

The HTTP version of the request.

@see web::WebReq.version

in

abstract InStream in()

Get the stream to read request body. See web::WebUtil.makeContentInStream to check under which conditions request content is available. If request content is not available, then throw an exception.

If the client specified the "Expect: 100-continue" header, then the first access of the request input stream will automatically send the client a 100 Continue response.

@see web::WebReq.in

isXmlHttpRequest

abstract Bool isXmlHttpRequest()

Returns true if an XMLHttpRequest, as specified by the X-Requested-With HTTP header.

locales

abstract Locale[] locales()

The accepted locales for this request based on the "Accept-Language" HTTP header. List is sorted by preference, where locales.first is best, and locales.last is worst. This list is guaranteed to contain Locale("en").

@see web::WebReq.locales

modBase

abstract Uri modBase()

Base uri of the current WebMod. Starts and ends with a /. Example, /pub/

@see web::WebReq.modBase

modRel

abstract Uri modRel()

The URI relative to BedSheetWebMod. Always starts with a /. Example, /index.html

@see web::WebReq.modRel

remoteAddr

abstract IpAddr remoteAddr()

The IP host address of the client socket making this request.

@see web::WebReq.remoteAddr

remotePort

abstract Int remotePort()

The IP port of the client socket making this request.

@see web::WebReq.remotePort

stash

abstract Str:Obj? stash()

Stash allows you to store temporary data on the request, to easily pass it between services and objects.

It is good for a quick hack, but if you find yourself relying on it, considering making a thread scoped service instead.

uri

abstract Uri uri()

The request URI including the query string relative to this authority. Also see absUri, modBase, modRel.

@see web::WebReq.uri