Skip to content


HTTP(s) client for outbound connectivity. This client supports HTTP and HTTPS connections over HTTP or SOCKS proxy. You can either use a destination (preferred way) or a URL as target. To use HTTPS you need to specify a trust store with the needed certificates (either in the destination or with setTrustStore).

To choose between HTTP and SOCKS proxy, the proxy URL starts with either http:// or socks://.

This HttpClient is equipped with a cookie database. If a previous response sent a set-cookie header, the cookie is stored for the relevant domain and path. Subsequent requests will be enriched with the stored cookies automatically.


Sample Usage

let http = $.net.http;

Read service.xshttpdest inside the Demo package that contains:
let destination = http.readDestination("Demo", "service");

// create client
let client = new http.Client();
let request = new http.Request(http.GET, "/"); // new Request(METHOD, PATH)
// the PATH will be prefixed by destination's pathPrefix, e.g. "/search?" on the request
// set the timeout in seconds
// send the request and synchronously get the response
client.request(request, destination);
let response = client.getResponse();

// get all the cookies and headers from the response
let cookies = [], headers = [];

for(let i = 0; i< response.cookies.length; i++) {

for(let i = 0; i< response.headers.length; i++) {

// check the contents of the response
$.response.setBody("status: " + response.status + " cookies: " + JSON.stringify(cookies) + " headers: " + JSON.stringify(headers) + " body: " + response.body.asString());


Function Description Returns
close() Close the connection. It is done automatically inside the HttpClientFacade. No need to call it explicitly! void
getResponse() Retrieve the response from the previously sent request synchronously/blocking. Throws an error if there is no valid response to return $.web.WebResponse
request($.net.http.Request, $.net.http.Destination) Send a new request object to the given destination. Throws an error if the request fails or the parameters are invalid. void
request($.net.http.Request, url, proxy (optional)) Send a request object to the given URL. Throws an error if the request fails or the parameters are invalid. void
request(WebMethod ($.net.http), url, proxy (optional)) Send a new request to the given URL, using the specified HTTP method. Throws an error if the request fails or the parameters are invalid. void
setTimeout(timeout) Sets the timeout for communication with the server. Throws an error if the parameter is not a numeric value. void
setTrustStore(trustStore) Sets the default trust store the will be used when issuing https:// requests via request(request, URI, ...)-syntax. void