Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.page.env Object Description
(system Template)

This object provides access to parameters passed to the server by the browser, and information that the server can determine from the underlying request. Each method on this object requests a specific environmental parameter.

For those familiar with the 'Common Gateway Interface' (cgi) the data available from this object closely mirrors the information available via that interface. In a traditional cgi application each of these parameters will be available as an 'environment variable'.

Methods

rb.page.env.get() The string value of the requested environment variable, or null if that variable is not defined
rb.page.env.ServerName() Return the virtual sever name to which the request was made.
rb.page.env.HostName() Return the host name to which the request was made.
rb.page.env.ServerSw() Name of the HTTP server executing the application.
rb.page.env.ModuleSw() Version of the Whitebeam module
rb.page.env.ServerProtocol() Protocol being used to service the request - eg HTTP/1.0
rb.page.env.ServerPort() TCP port number that received the request - usually port 80
rb.page.env.RequestMethod() HTTP method used to access the resource - eg GET or POST
rb.page.env.PathInfo() Trailing path information from the URL requested by the client
rb.page.env.QueryString() Decoded query parameters from the URL - eg after the '?' character.
rb.page.env.RemoteHost() Name of the remote host - if known
rb.page.env.RemoteAddr() IP address of the client requesting the resource.
rb.page.env.Path() Return the path from the requested page
rb.page.env.UserAgent() Allows identification of client application, eg Internet Explorer or Navigator
rb.page.env.Referer() HTTP refer field
rb.page.env.ProxyConnection() Identifies the intermediate proxy server making this request.
rb.page.env.RemoteUser() User identification from the client
rb.page.env.Status() Return the current page status.

Aggregate Types

rb.page.env.versionData Whitebeam module version information.
Whitebeam release 1.3.36
(loadtime : 72ms)