Class WebServerRequest

Object
   |
   +--WebServerRequest

class WebServerRequest

Request made to the Web server.

WebServerRequest holds information about the incoming request, such as its URI, method and any data sent along with it.

Field Detail

body

String body

The full body of the HTTP request as a String. Readonly. If the body is non existintant or binary, this property is null.

bodyItems

Object bodyItems

The items in the body of this request, meaning data sent as POST. Readonly.

This property will contain a dictionary of only those items sent as part of the body of the request, for example large amounts of text or sensitive information such as passwords that should not be visible in the URL.

As each CGI parameter may occur multiple times, each key/property of the dictionary points to an array-like object of values.

password = request.bodyItems.passwords[0];
password = request.bodyItems['passwords'][0];
passwords = request.bodyItems.passwords

connection

WebServerConnection connection

The connection this request was sent through. Readonly.

files

File files

Files uploaded with this request. Readonly.

This File object represents a virtual directory which points to the uploaded files. Access the individual files by getting the listing from the file.

The name of the file is the filename the user selected when uploading.

Request headers for these files are available through the metaData property: req.files[0].metaData.headers['some header'];

See the File API for details about files.

headers

Object headers

The HTTP headers sent with this request. Readonly.

This property will contain a dictionary of HTTP headers sent with this request. As each HTTP header may occur multiple times, each key/property of the dictionary points to an array-like object of values:

firstCookie = request.headers.Cookie[0];
firstCookie = request.headers['Cookie'][0];

host

String host

The value of the Host header sent with this request. Readonly. As opposed to the uri property, this will give you the host name the request was made to, which can be used for among other things redirects. This may contain the port of the request, i.e. 'foo.bar:80'.

ip

String ip

The IP address of the client that sent this request. Readonly.

This currently only gives you the IP address of the proxy.

method

String method

The HTTP method of this request, one of GET, POST, PUT or DELETE. Readonly.

protocol

String protocol

The protocol this request was made to. Readonly. This is either 'http' or 'https'. Use it to construct links and redirects and preserve the correct security qualifications of the URIs.

queryItems

Object queryItems

The items sent as part of the query string in this request, meaning data sent as GET. Readonly.

This property will contain a dictionary of only those items sent as part of the query string i.e. anything after the ? in the URL.

As each CGI parameter may occur multiple times, each key/property of the dictionary points to an array-like object of values.

user = request.queryItems.user[0];
user = request.queryItems['user'][0];
users = request.queryItems.users;

uri

String uri

The relative Uniform Resource Identifier this request was made to.

Relative URI the request is made out to, starting with '/' and the name of the service, e.g. http://work.john.operaunite.com/wiki/add becomes '/wiki/add'. It is rewritable to allow redispatching of the request. See the WebServerResponse.closeAndRedispatch() method.

Setting this property will throw a SECURITY_ERR if an invalid URI is set or if the URI points to a different service than the one the request was issued from.

WebServerRequest

WebServerRequest()

This class has no public constructor.

getItem

Object getItem( <String> requestItem, <String> method )

Get the value of a request item.

This method gets the values of items sent in a query string (typically through GET requests) or in the body of the request (typically through POST requests). Each item may occur multiple times with different values, both in the query string and the body. The optional second argument method can be used to limit the selection to either of those two.

Examples:

In the case of a query string foo=bar:

getItem( 'foo' ) will produce an array-like object [ 'bar' ].

In the case of a query string foo=bar&foo=baz:

getItem( 'foo' ) will produce an array-like object [ 'bar', 'baz' ].

In the case of a query string foo=bar and a request body containing foo=baz:

getItem( 'foo', 'POST' ) will produce an array-like object [ 'baz' ].

Parameters:
requestItem - Name of the request item to get
method - Optional argument with the method of the request item to get, either GET or POST.

Returns:
Array-like object of values for the given request item, or null if there are no values for the given request item.

getRequestHeader

Object getRequestHeader( <String> requestHeader )

Get the values of a HTTP header in the request.

The returned object is a collection of headers matching the given header name.

Example:

Assuming that the client sent a request with a header of Foo, access it as follows:

 headers = request.getRequestHeader('Foo');
 if ( headers )
 {
     opera.postError(headers[0]);
 }

Parameters:
requestHeader - Name of the HTTP header to get.

Returns:
Array-like object with headers matching the given name, or null if there are no headers with the given name.