A map of HTTP parameters.
| Property | Description |
|---|---|
parameterCount: Number (read-only) | Returns the number of paramters in this http parameter map. |
parameterNames: Set (read-only) | Returns a collection of all parameter names. |
requestBodyAsString: String (read-only) | Returns the HTTP request body as string (e.g. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| get(Object) | Returns the http parameter for the given key or an empty http parameter, if no parameter is defined for that key. |
| getParameterCount() | Returns the number of paramters in this http parameter map. |
| getParameterMap(String) | Returns a sub-map containing all parameters that start with the given prefix. |
| getParameterNames() | Returns a collection of all parameter names. |
| getRequestBodyAsString() | Returns the HTTP request body as string (e.g. |
| isParameterSubmitted(String) | Identifies if the parameter has been submitted. |
| processMultipart(Function) | This method can be called to process a form submission for an HTML form with encoding type “multipart/form-data”. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the number of paramters in this http parameter map.
(read-only)Returns a collection of all parameter names.
(read-only)Returns the HTTP request body as string (e.g. useful for XML posts). A body is only returned if the request is a POST or PUT request and was not send with "application/x-www-form-urlencoded" encoding. If the request was send with that encoding it is interpreted as form data and the body will be empty.
Returns the http parameter for the given key or an empty http parameter, if no parameter is defined for that key. An empty parameter returns false for the method isDefined().
Parameters:
Returns:
Returns the number of paramters in this http parameter map.
Returns:
Returns a sub-map containing all parameters that start with the given prefix. The prefix will be removed from the parameter names in the returned sub-map. For example with the parameters "pre_P1" and "pre_p2" a call with "pre_" as parameter will return a HttpParameterMap containing "P1" and "P2".
Parameters:
Returns:
Returns a collection of all parameter names.
Returns:
Returns the HTTP request body as string (e.g. useful for XML posts). A body is only returned if the request is a POST or PUT request and was not send with "application/x-www-form-urlencoded" encoding. If the request was send with that encoding it is interpreted as form data and the body will be empty.
Returns:
Identifies if the parameter has been submitted.
Parameters:
Returns:
This method can be called to process a form submission for an HTML form with encoding type "multipart/form-data". Such a form can have a mixture of "regular" HTML form fields and also file uploads.
Form fields are available via get(Object) without calling this method. Uploaded files still need to be processed via the passed callback function.
This callback function is called for each file upload part in the request. The parameters are the field name, the content type and the original file name. The function can return either a null, which means that the upload of this part should be skipped, or return a dw.io.File instance. If the file is an existing directory the system will automatically generate a unique file name. If the file is not an existing directory the uploaded content will be directly stored into that file. An existing file with the same name will be deleted. If the file can't be deleted for whatever reason, the upload is stored with a generated unique file name in the indicated directory.
An automatically generated file name consists of the the prefix "upload", a time stamp, a unique id and the extension tmp. For example: "upload_20070114221535_bc7H1aOadI9qYaaacovPd3lqna.tmp".
1var params : HttpParameterMap = pdict.CurrentHttpParameterMap;
2
3// Get the file name from the first field. This is works because the
4// parameter map is updated before the file part is parsed.
5var files : LinkedHashMap = params.processMultipart( (function( field, ct, oname ){
6 return new File( File.IMPEX + "/" + params.firstField );
7}) );Parameters:
Returns:
null if this is not a multipart request
j