Default properties and methods of the req object.
This object is automatically instantiated as the req property
of the global object (or global.req) and there is no constructor
to instantiate further instances.
The req object is a host object representing the request that is currently handled by the scripting environment.
The req object is a host object representing the request that is currently handled by the scripting environment.
For further details also see the JavaDocs for helma.framework.RequestBean. Since that class is a JavaBean all of its get- and set-methods are also directly available as properties of this object.
see
Contains the name of the requested action
The name without the suffix '_action' is provided. This property is read-only.
Example:
The name without the suffix '_action' is provided. This property is read-only.
Example:
res.write(req.action); edit
The function in charge of handling the current request.
The req.actionHandler property allows the onRequest() method to set the function object to be invoked for handling the request, overriding the action resolved from the request path.
The req.actionHandler property allows the onRequest() method to set the function object to be invoked for handling the request, overriding the action resolved from the request path.
since: 1.7
Contains the cookie request parameters.
see
Object containing any request parameters (GET, POST, Cookies, etc) and HTTP environmental variables.
This object contains all passed request parameters as named properties, no matter whether these have been submitted as URL-parameters, as part of a HTTP POST request, or as cookie values.
When more than one value is submitted for the same parameter name, req.data.paramname contains just a single (the first) value. That is why all parameters are additionally also provided with their values inside an array, through properites called req.data.paramname_array (the same parameter name, with an _array suffix attached).
Parameters can be grouped into objects using a "objectid[partid]" syntax in the parameter name. For example, a parameter name of "foo[bar]" will result in a req.data.foo object being created. The actual parameter value will be available at req.data.foo.bar. This feature can be used recursively, meaning that a parameter named "foo[bar][dong]" will result in req.data.foo.bar.dong.
Uploaded files are available in req.data as a MimePart object.
Additionally Helma sets the following HTTP environment variables if they are available:
All properties of req.data are read- and write-able.
This object contains all passed request parameters as named properties, no matter whether these have been submitted as URL-parameters, as part of a HTTP POST request, or as cookie values.
When more than one value is submitted for the same parameter name, req.data.paramname contains just a single (the first) value. That is why all parameters are additionally also provided with their values inside an array, through properites called req.data.paramname_array (the same parameter name, with an _array suffix attached).
Parameters can be grouped into objects using a "objectid[partid]" syntax in the parameter name. For example, a parameter name of "foo[bar]" will result in a req.data.foo object being created. The actual parameter value will be available at req.data.foo.bar. This feature can be used recursively, meaning that a parameter named "foo[bar][dong]" will result in req.data.foo.bar.dong.
Uploaded files are available in req.data as a MimePart object.
Additionally Helma sets the following HTTP environment variables if they are available:
- authorization
- Equivalent to the variable 'authorization' sent in the request header.
- http_browser
- Name and version of the client browser. Equivalent to the variable 'User-Agent' sent in the request header.
- http_host
- Host name to which that request was sent to. Equivalent to the variable 'Host' sent in the request header.
- http_language
- Equivalent to the variable 'Accept-Language' sent in the request header.
- http_language
- Equivalent to the variable 'Accept-Language' sent in the request header.
- http_remotehost
- IP-Address of the client machine. Equivalent to a getRemoteAddr() call on the servletRequest.
- http_referer
- URL of the page the user came from. Equivalent to the variable 'Referer' sent in the request header.
- http_get_remainder
- Provides access to any bytes remaining after GET parameter parsing.
- http_post_remainder
- Provides access to any bytes remaining after POST parameter parsing.
All properties of req.data are read- and write-able.
see
Returns the HTTP method (in uppercase letters) of the current request.
Usually 'GET' or 'POST'. For non-web-requests this function will return one of the following: 'XMLRPC', 'EXTERNAL' or 'INTERNAL'.
Usually 'GET' or 'POST'. For non-web-requests this function will return one of the following: 'XMLRPC', 'EXTERNAL' or 'INTERNAL'.
see
Contains any GET and POST request parameters.
Combined properties of req.postParams and req.queryParams
Combined properties of req.postParams and req.queryParams
see
Returns the decrypted basic authentication password.
Only for requests that contain user credentials sent with ' basic authentication scheme' method, typically as a result of a previously returned 401 HTTP response.
Only for requests that contain user credentials sent with ' basic authentication scheme' method, typically as a result of a previously returned 401 HTTP response.
see
Contains the path of the current request, relative to the application's mountpoint.
Starts without a preceding slash. This property is read-only.
Starts without a preceding slash. This property is read-only.
see
Contains any post request parameters.
see
Contains any GET request style query string parameters.
see
The running time of the current request in milliseconds
Provides the amount of time that has elapsed since the start of the processing of the current request, measured in milliseconds (integer).
Provides the amount of time that has elapsed since the start of the processing of the current request, measured in milliseconds (integer).
Contains the full request URI path from the web server root.
Compared to req.path, which only contains the path from wherever the application is mounted, req.uri provides easy access to the full request URI. The purpose is to make it easy to link to the current page without having to invoke href(). For internal (non-HTTP) invocations, req.uri is null.
Compared to req.path, which only contains the path from wherever the application is mounted, req.uri provides easy access to the full request URI. The purpose is to make it easy to link to the current page without having to invoke href(). For internal (non-HTTP) invocations, req.uri is null.
since: 1.7
see
Contains the decrypted basic authentication username.
Only for requests that contain user credentials sent with ' basic authentication scheme' method, typically as a result of a previously returned 401 HTTP response.
Only for requests that contain user credentials sent with ' basic authentication scheme' method, typically as a result of a previously returned 401 HTTP response.
see
Methods
An alternative method of accessing properties
otherwise made available through the req.data object.
parameters
| String | name | as String, the request data property to read |
see
Returns the specified header value, or null
If there are several headers by that name, the first header value is returned. Proxy to HttpServletRequest.getHeader().
If there are several headers by that name, the first header value is returned. Proxy to HttpServletRequest.getHeader().
parameters
| String | name | as String, the header name |
returns
| String the header value, or null |
see
Returns an Array of all header values by the specified name
Proxy to HttpServletRequest.getHeaders(), returns header values as string array.
Proxy to HttpServletRequest.getHeaders(), returns header values as string array.
parameters
| String | name | as String, the header name |
returns
| Array of Strings containing the header values |
see
Returns the specified header value as a Number
Proxy to HttpServletRequest.getIntHeader(), fails silently by returning -1.
Proxy to HttpServletRequest.getIntHeader(), fails silently by returning -1.
parameters
| String | name | as String, the header name |
returns
| Number the header parsed as integer or -1 |
Returns the specified header value as a Date object
Proxy to HttpServletRequest.getDateHeader(), fails silently by returning -1.
Proxy to HttpServletRequest.getDateHeader(), fails silently by returning -1.
parameters
| String | name | as String, the header name |
returns
| Date the date in milliseconds, or -1 |
Returns true if the current request is a HTTP GET request, false otherwise.
returns
| Boolean |
see
Returns true if the current request is a HTTP POST request, false otherwise.
returns
| Boolean |
see
Provides access to the HttpServletRequest object
Returns an instance of the Java HttpServletRequest Class corresponding to the current request, which allows full access to the methods of that class.
Returns an instance of the Java HttpServletRequest Class corresponding to the current request, which allows full access to the methods of that class.
returns
| Packages.javax.servlet.http.HttpServletRequest object of the current request |
see