Jaxer.Request

An instance of this object has the lifecycle of the current request and contains information about it.

Constructor

An instance of this class is accessible globally from any Server side code under the namespace Jaxer.request.

Properties

  • Jaxer.request.app
  • The Jaxer.App object constructed by searching in configApps.js for an object that matches the current request's parsedUrl and using it to set application-specific settings (such as the database connection to use) during this request.

  • Jaxer.request.body
  • The body of the HTTP request, which usually contains the data during a POST request, and is often of type 'application/x-www-form-urlencoded' (i.e. "name1=value1&name2=value2&..."). The type of data returned by this property depends on the Content-Type of the request and on Config.REQUEST_BODY_AS.

  • Jaxer.request.bodyAsByteArray
  • The body of this request (usually the payload of a POST request) as a byte array, which may be empty. For example, a GET request always has an empty body.

  • Jaxer.request.bodyAsString
  • The body of this request (usually the payload of a POST request) as a string, which may be empty. For example, a GET request always has an empty body. NOTE that when the contentType is 'multipart/form-data' this will always be '', indicating that the body of the request has been pre-processed by Jaxer and is instead available via the files and data properties.

  • Jaxer.request.contentLength
  • The Content-Length in bytes of the body of this request. NOTE that when the contentType is 'multipart/form-data' this will always return 0, indicating that the body of the request has been pre-processed by Jaxer and is instead available via the files and data properties.

  • Jaxer.request.contentType
  • The Content-Type (i.e. mime-type) of the body of this request, which describes the body of this request. Usually this will be 'application/x-www-form-urlencoded' or 'multipart/form-data'.

  • Jaxer.request.currentFolder
  • The folder (directory) on disk holding the file (pageFile) being served in this request. This is '' if there is no pageFile information, e.g. if the web server is on a different filesystem than Jaxer.

  • Jaxer.request.data
  • An object holding the name=value pairs of the current request's body (assumed to be of type application/x-www-form-urlencoded) as properties.

  • Jaxer.request.documentRoot
  • The location on disk of the top folder from which all web pages are served by the web server, as an absolute URL (without the preceding file://). This is usually only meaningful if the web server is on the same filesystem as Jaxer.

  • Jaxer.request.env
  • A collection of the environment variables received from the web server for this request, as properties on this simple JavaScript object. If multiple variables had the same name, their values are given as an array.

  • Jaxer.request.env
  • A collection of the environment variables received from the web server for this request, as properties on this simple JavaScript object. If multiple variables had the same name, their values are given as an array.

  • Jaxer.request.files
  • An array of Jaxer.Request.FileInfo objects describing any uploaded files. You must call save(newFileName) on each of these if you'd like to save them, otherwise they will be purged at the end of the request.

  • Jaxer.request.headers
  • A collection of the HTTP headers received from the web server for this request, as properties on this simple JavaScript object. If multiple headers had the same name, their values are given as an array.

  • Jaxer.request.method
  • The type of HTTP request this is: usually "GET" or "POST". Guaranteed to be all upper-case.

  • Jaxer.request.paramIsBody
  • True if the entire body of the request is to be considered as the single data parameter of this request.

  • Jaxer.request.parsedUrl
  • Holds the parsed URL information of the true page: this is the current URL for a regularly-served page, but for a callback this is the URL of the original page (now the Referer) that requested the callback.

  • Jaxer.request.protocol
  • The protocol declared in the HTTP request, e.g. "HTTP/1.1".

  • Jaxer.request.queryString
  • The query part of the current request's URL, after the "?". This is also available as Jaxer.request.parsedUrl.query and is parsed into the JavaScript object Jaxer.request.parsedUrl.queryParts.

  • Jaxer.request.referer
  • The value of the Referer HTTP header for this request, which should indicate the complete URL of the page that made this request. If this is a callback, the referer is taken from the "callingPage" parameter of the request, only using the Referer header if for some reason "callingPage" is not available.

  • Jaxer.request.remoteAddr
  • The Internet Protocol (IP) address of the client (browser) that sent the request.

  • Jaxer.request.remoteHost
  • The hostname of the client (browser) that sent the request, or the IP address of the client if the hostname cannot be determined.

  • Jaxer.request.remoteUser
  • If the browser making the request submitted HTTP authentication credentials, this is the username submitted. Otherwise it is the empty string.

  • Jaxer.request.uri
  • The URL (and URI) of the current request.

  • Jaxer.request.userAgent
  • The string used to identify the user agent of the client making the request.