PatchRequest
Overview
The PatchRequest
class facilitates handling HTTP PATCH requests for updating resources on a server. It supports adding files, parameters, and headers to requests while providing methods to configure the request body and authentication options.
Developers can include files in the request with addFile()
methods, which support specifying file details and MIME types. Parameters can be added using addParameter()
, with support for custom MIME types when required. For configuring request bodies directly, the setBodyContent()
method is available with optional MIME type specifications.
Requests can be executed synchronously using executeRequest()
or asynchronously with executeAsyncRequest()
, offering support for callbacks to handle responses or errors. Authentication options include preemptive authentication, Windows authentication, and user credentials, ensuring compatibility with various server requirements. The forceMultipart()
method allows requests to be formatted as multipart/form-data
when needed, even for single-file uploads.
A sample creating a PatchRequest
can be found here: createPatchRequest.
Methods Summarized
Type | Name | Summary |
---|---|---|
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes. | ||
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes). | ||
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes. | ||
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes). | ||
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes. | ||
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes). | ||
Add a header to the request. | ||
Add a parameter to the post. | ||
Add a parameter to the post. | ||
void | Execute the request method asynchronous. | |
void | Execute the request method asynchronous using windows authentication. | |
void | Execute the request method asynchronous. | |
void | Execute the request method asynchronous using windows authentication. | |
void | Execute the request method asynchronous. | |
void | Execute the request method asynchronous using windows authentication. | |
Execute the request method. | ||
Execute the request method. | ||
Execute a request method using windows authentication. | ||
void | Force this request to prepare a "Content-Type: multipart/form-data" formatted message even if only one file or only a number of parameter were added to it. | |
void | Set the body of the request. | |
void | Set the body of the request and content mime type. | |
void | Set the charset used when posting. | |
void | Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent) |
Methods Detailed
addFile(parameterName, jsFile)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Returns: Boolean
Sample
addFile(parameterName, jsFile, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
String parameterName ;
Object jsFile ;
String mimeType The mime type that must be used could be the real default ('application/octet-stream') if the files one (by name or by its first bytes) is not good.
Returns: Boolean
Sample
addFile(parameterName, fileName, jsFile)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Returns: Boolean
Sample
addFile(parameterName, fileName, jsFile, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
String parameterName ;
String fileName ;
Object jsFile ;
String mimeType The mime type that must be used could be the real default ('application/octet-stream') if the files one (by name or by its first bytes) is not good.
Returns: Boolean
Sample
addFile(parameterName, fileName, fileLocation)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or a file and at least a parameter via addParameter(...).
Parameters
Returns: Boolean
Sample
addFile(parameterName, fileName, fileLocation, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
String parameterName ;
String fileName ;
String fileLocation ;
String mimeType The mime type that must be used could be the real default ('application/octet-stream') if the files one (by name or by its first bytes) is not good.
Returns: Boolean
Sample
addHeader(headerName, value)
Add a header to the request.
Parameters
Returns: Boolean
Sample
addParameter(name, value)
Add a parameter to the post.
If there is also at least one file added to this request using addFile(...) then a multi-part post will be generated.
Parameters
Returns: Boolean
Sample
addParameter(name, value, mimeType)
Add a parameter to the post.
If there is also at least one file added to this request using addFile(...) then a multi-part post will be generated. The multipart element will also contain content-type header, set from mimeType and charset. By default, this header is not present.
Parameters
Returns: Boolean
Sample
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
String username the user name
String password the password
String workstation The workstation the authentication request is originating from.
String domain The domain to authenticate within.
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Returns: void
Sample
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Execute the request method asynchronous using windows authentication. Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
String username the user name
String password the password
String workstation The workstation the authentication request is originating from.
String domain The domain to authenticate within.
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Array callbackExtraArgs extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)
Returns: void
Sample
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
String username the user name
String password the password
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Returns: void
Sample
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Execute the request method asynchronous using windows authentication. Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
String username the user name
String password the password
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Array callbackExtraArgs extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)
Returns: void
Sample
executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Returns: void
Sample
executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Execute the request method asynchronous using windows authentication. Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out
Array callbackExtraArgs extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)
Returns: void
Sample
executeRequest()
Execute the request method.
Returns: Response
Sample
executeRequest(userName, password)
Execute the request method.
Parameters
Returns: Response
Sample
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.
Parameters
String userName the user name
String password the password
String workstation The workstation the authentication request is originating from.
String domain The domain to authenticate within.
Returns: Response
Sample
forceMultipart(forceMultipart)
Force this request to prepare a "Content-Type: multipart/form-data" formatted message even if only one file or only a number of parameter were added to it.
It is useful because some servers require this (they only support multipart - even if you don't need to send multiple things). Before Servoy 2021.03 you could force it to send multipart by adding a dummy parameter together with a single file (or the other way around) - if the server didn't object to that dummy content...
Default value: false. (if you only add one file or only parameters it will not generate a multipart request)
Parameters
Boolean forceMultipart if true, this request will send a multipart/form-data message even if you only add one file or only parameters. If false (default) it will send multipart only in case of multiple files or one file plus at least one parameter.
Returns: void
setBodyContent(content)
Set the body of the request.
Parameters
String content ;
Returns: void
Sample
setBodyContent(content, mimeType)
Set the body of the request and content mime type.
Parameters
Returns: void
Sample
setCharset(charset)
Set the charset used when posting. If this is null or not called it will use the default charset (UTF-8).
Parameters
Object charset ;
Returns: void
Sample
usePreemptiveAuthentication(b)
Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent)
Parameters
Boolean b ;
Returns: void
Last updated