HttpClient

Overview

A wrapper for Apache HttpClient for executing requests like GET, POST, PUT, and more, with support for cookies, proxies, and timeouts.

Features

The client facilitates various HTTP requests (e.g., GET, POST, DELETE) and supports configuration options like cookies, proxy servers, and timeouts. It enables both synchronous and asynchronous communication, offering flexibility for different use cases.

For configuration details, see the Http client configuration section.

Methods Summarized

Type	Name	Summary
void	close()	releases all resources that this client has, should be called after usage.
DeleteRequest	createDeleteRequest(url)	Creates a new delete request (a request to delete a resource on server).
GetRequest	createGetRequest(url)	Creates a new get request (retrieves whatever information is stored on specified url).
HeadRequest	createHeadRequest(url)	Creates a new head request (similar to get request, must not contain body content).
OptionsRequest	createOptionsRequest(url)	Creates a new options request (a request for information about communication options).
PatchRequest	createPatchRequest(url)	Creates a new patch request (used for granular updates).
PostRequest	createPostRequest(url)	Create a new post request ( Origin server should accept/process the submitted data.
PutRequest	createPutRequest(url)	Creates a new put request (similar to post request, contains information to be submitted).
TraceRequest	createTraceRequest(url)	Creates a new trace request (debug request, server will just echo back).
Promise	execute(requests)	Execute multiple requests asynchronously.
Promise	executeRequest(requests, username, password)	Execute multiple requests asynchronously, it assumes that all request are to the same server (it gives the same username, password to all requests).
Promise	executeRequest(requests, username, password, workstation, domain)	Execute multiple requests asynchronously, it assumes that all request are to the same server (it gives the same username, password, workstation and domain to all requests).
Cookie	getCookie(cookieName)	Get a cookie by name.
Array	getCookies()	Get all cookies from this client.
void	setClientProxyCredentials(userName, password)	Set proxy credentials.
void	setClientProxyServer(hostname, port)	Set proxy server.
Boolean	setCookie(cookieName, cookieValue)	Add cookie to the this client.
Boolean	setCookie(cookieName, cookieValue, domain)	Add cookie to the this client.
Boolean	setCookie(cookieName, cookieValue, domain, path)	Add cookie to the this client.
Boolean	setCookie(cookieName, cookieValue, domain, path, maxAge)	Add cookie to the this client.
Boolean	setCookie(cookieName, cookieValue, domain, path, maxAge, secure)	Add cookie to the this client.
void	setTimeout(msTimeout)	Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).

Methods Detailed

close()

releases all resources that this client has, should be called after usage.

Returns: void

createDeleteRequest(url)

Creates a new delete request (a request to delete a resource on server).

Parameters

• String url ;

Returns: DeleteRequest a DeleteRequest object for creating a DELETE request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createDeleteRequest('http://www.servoy.com/delete.me');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();

createGetRequest(url)

Creates a new get request (retrieves whatever information is stored on specified url). If this url is a https ssl encrypted url which certificates are not in the java certificate store. (Like a self signed certificate or a none existing root certificate) Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time. For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server. See https://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file

Parameters

• String url ;

Returns: GetRequest a GetRequest object for creating a GET request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createGetRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();

createHeadRequest(url)

Creates a new head request (similar to get request, must not contain body content).

Parameters

• String url ;

Returns: HeadRequest a HeadRequest object for creating a HEAD request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createHeadRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok
var header = response.getResponseHeaders('last-modified');

createOptionsRequest(url)

Creates a new options request (a request for information about communication options).

Parameters

• String url ;

Returns: OptionsRequest an OptionsRequest object for creating an OPTIONS request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createOptionsRequest('http://www.servoy.com');
var methods = request.getAllowedMethods(request.executeRequest());

createPatchRequest(url)

Creates a new patch request (used for granular updates).

Parameters

• String url ;

Returns: PatchRequest a PatchRequest object for creating a PATCH request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createPatchRequest('http://jakarta.apache.org');
request.setBodyContent('{"email": "[e-mail]"}','application/json');
var httpCode = request.executeRequest().getStatusCode() // httpCode 200 is ok

createPostRequest(url)

Create a new post request ( Origin server should accept/process the submitted data.) If this url is a https ssl encrypted url which certificates are not in the java certificate store. (Like a self signed certificate or a none existing root certificate) Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time. For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server. See https://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file

Parameters

• String url ;

Returns: PostRequest a PostRequest object for creating a POST request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var poster = client.createPostRequest('https://twitter.com/statuses/update.json');
poster.addParameter('status',globals.textToPost);
poster.addParameter('source','Test Source');
poster.setCharset('UTF-8');
var httpCode = poster.executeRequest(globals.twitterUserName, globals.twitterPassword).getStatusCode(); // httpCode 200 is ok

createPutRequest(url)

Creates a new put request (similar to post request, contains information to be submitted).

Parameters

• String url ;

Returns: PutRequest a PutRequest object for creating a PUT request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var request = client.createPutRequest('http://jakarta.apache.org');
request.setFile('UploadMe.gif');
var httpCode = putRequest.executeRequest().getStatusCode() // httpCode 200 is ok

createTraceRequest(url)

Creates a new trace request (debug request, server will just echo back).

Parameters

• String url ;

Returns: TraceRequest a TraceRequest object for creating a TRACE request to the specified URL.

Sample

var client = plugins.http.createNewHttpClient();
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();

execute(requests)

Execute multiple requests asynchronously. A Promise is returned that resolves with an array of Response objects when all requests are complete in the same order as the Request objects. Because some request can fail and others can just work, this promise will always just resolve (not reject) with response object having the message of the error or the actual normal response.

Parameters

• Array requests ;

Returns: Promise The promise object that resolves with an array of Response objects when all requests are complete in the same order as the Request objects.

Sample

var client = plugins.http.createNewHttpClient();
var requests = [];
requests.push(client.createGetRequest("https://www.google.com"))
requests.push(client.createGetRequest("https://servoy.com"))
var promise = client.execute(requests)
promise.then(/** @type {Array<plugins.http.Response>} */
responses => {
   for (var index = 0; index < responses.length; index++) {
     application.output(responses[index].getStatusCode())
     application.output(responses[index].getResponseBody().substring(0,100));
     application.output(responses[index].getFileUpload());
     responses[index].close();
   }
});

executeRequest(requests, username, password)

Execute multiple requests asynchronously, it assumes that all request are to the same server (it gives the same username, password to all requests).

A Promise is returned that resolves with an array of Response objects when all requests are complete in the same order as the Request objects. Because some request can fail and others can just work, this promise will always just resolve (not reject) with response object having the message of the error or the actual normal response.

Parameters

• Array requests ;
• String username the user name
• String password the password

Returns: Promise The promise object that resolves with an array of Response objects when all requests are complete in the same order as the Request objects.

Sample

var client = plugins.http.createNewHttpClient();
var requests = [];
requests.push(client.createGetRequest("https://www.google.com"))
requests.push(client.createGetRequest("https://servoy.com"))
var promise = client.execute(requests)
promise.then(/** @type {Array<plugins.http.Response>} */
responses => {
   for (var index = 0; index < responses.length; index++) {
     application.output(responses[index].getStatusCode())
     application.output(responses[index].getResponseBody().substring(0,100));
     application.output(responses[index].getFileUpload());
     responses[index].close();
   }
});

executeRequest(requests, username, password, workstation, domain)

Execute multiple requests asynchronously, it assumes that all request are to the same server (it gives the same username, password, workstation and domain to all requests).

A Promise is returned that resolves with an array of Response objects when all requests are complete in the same order as the Request objects. Because some request can fail and others can just work, this promise will always just resolve (not reject) with response object having the message of the error or the actual normal response.

BaseRequest[] request

Parameters

• Array requests ;
• 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: Promise The promise object that resolves with an array of Response objects when all requests are complete in the same order as the Request objects.

getCookie(cookieName)

Get a cookie by name.

Parameters

• String cookieName ;

Returns: Cookie the cookie with the specified name, or null if it does not exist.

Sample

var cookie = client.getCookie('JSESSIONID');
if (cookie != null)
{
	// do something
}
else
	client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)

getCookies()

Get all cookies from this client.

Returns: Array an array of all cookies currently stored in the client.

Sample

var cookies = client.getHttpClientCookies()

setClientProxyCredentials(userName, password)

Set proxy credentials.

Parameters

• String userName ;
• String password ;

Returns: void

Sample

client.setClientProxyCredentials('my_proxy_username','my_proxy_password');

setClientProxyServer(hostname, port)

Set proxy server.

Parameters

• String hostname - proxy host // null value will clear proxyHost settings;
• Number port - proxy port //null value will clear proxyHost settings;

Returns: void

Sample

client.setClientProxyServer('server',port);

setCookie(cookieName, cookieValue)

Add cookie to the this client.

Parameters

• String cookieName the name of the cookie
• String cookieValue the value of the cookie

Returns: Boolean true if the cookie was successfully set; otherwise, false.

Sample

var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

setCookie(cookieName, cookieValue, domain)

Add cookie to the this client.

Parameters

• String cookieName the name of the cookie
• String cookieValue the value of the cookie
• String domain the domain

Returns: Boolean true if the cookie was successfully set; otherwise, false.

Sample

var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

setCookie(cookieName, cookieValue, domain, path)

Add cookie to the this client.

Parameters

• String cookieName the name of the cookie
• String cookieValue the value of the cookie
• String domain the domain
• String path the path

Returns: Boolean true if the cookie was successfully set; otherwise, false.

Sample

var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

setCookie(cookieName, cookieValue, domain, path, maxAge)

Add cookie to the this client.

Parameters

• String cookieName the name of the cookie
• String cookieValue the value of the cookie
• String domain the domain
• String path the path
• Number maxAge maximum age of cookie

Returns: Boolean true if the cookie was successfully set; otherwise, false.

Sample

var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

setCookie(cookieName, cookieValue, domain, path, maxAge, secure)

Add cookie to the this client.

Parameters

• String cookieName the name of the cookie
• String cookieValue the value of the cookie
• String domain the domain
• String path the path
• Number maxAge maximum age of cookie
• Boolean secure true if it is a secure cookie, false otherwise

Returns: Boolean true if the cookie was successfully set; otherwise, false.

Sample

var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

setTimeout(msTimeout)

Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).

Parameters

• Object msTimeout ;

Returns: void

Sample

client.setTimeout(1000)

---