SendCustomRequest Method
Sends a custom request to the server.
Syntax
wasabi.sendCustomRequest(httpMethod, objectName, requestBody, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The ObjectName and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, based on the following:
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
- Bucket (if non-empty)
- ObjectName (if non-empty)
- VersionId (if both it and ObjectName are non-empty)
- QueryParam*
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Adds request headers from:
- Signs the request (unless the SignCustomRequest configuration setting is disabled).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.