HttpClient

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

DeleteRequest

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

GetRequest

Unknown macro: {td}

createGetRequest(url)
Creates a new get request (retrieves whatever information is stored on specified url).

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

HeadRequest

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

OptionsRequest

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

PostRequest

Unknown macro: {td}

createPostRequest(url)
Create a new post request ( Origin server should accept/process the submitted data.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

PutRequest

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

TraceRequest

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Cookie

Unknown macro: {td}

getCookie(cookieName)
Get a cookie by name.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Cookie[]

Unknown macro: {td}

getCookies()
Get all cookies from this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setClientProxyCredentials(userName, password)
Set proxy credentials.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setCookie(cookieName, cookieValue)
Add cookie to the this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setCookie(cookieName, cookieValue, domain)
Add cookie to the this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setCookie(cookieName, cookieValue, domain, path)
Add cookie to the this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setCookie(cookieName, cookieValue, domain, path, maxAge)
Add cookie to the this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setCookie(cookieName, cookieValue, domain, path, maxAge, secure)
Add cookie to the this client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createDeleteRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

DeleteRequest

Unknown macro: {span}

createDeleteRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

DeleteRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createGetRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

GetRequest

Unknown macro: {span}

createGetRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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 http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

GetRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createHeadRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

HeadRequest

Unknown macro: {span}

createHeadRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

HeadRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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');

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createOptionsRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

OptionsRequest

Unknown macro: {span}

createOptionsRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

OptionsRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createPostRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

PostRequest

Unknown macro: {span}

createPostRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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 http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

PostRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createPutRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

PutRequest

Unknown macro: {span}

createPutRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

PutRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createTraceRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

TraceRequest

Unknown macro: {span}

createTraceRequest

Unknown macro: {span}

(url)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} url

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

TraceRequest

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Cookie

Unknown macro: {span}

getCookie

Unknown macro: {span}

(cookieName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get a cookie by name.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} cookieName

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Cookie

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCookies

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Cookie[]

Unknown macro: {span}

getCookies

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get all cookies from this client.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Cookie[]

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var cookies = client.getHttpClientCookies()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setClientProxyCredentials

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

setClientProxyCredentials

Unknown macro: {span}

(userName, password)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set proxy credentials.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} userName
{String} password

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setCookie

Unknown macro: {span}

(cookieName, cookieValue)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add cookie to the this client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} cookieName – the name of the cookie
{String} cookieValue – the value of the cookie

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setCookie

Unknown macro: {span}

(cookieName, cookieValue, domain)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add cookie to the this client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} cookieName – the name of the cookie
{String} cookieValue – the value of the cookie
{String} domain – the domain

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setCookie

Unknown macro: {span}

(cookieName, cookieValue, domain, path)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add cookie to the this client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} cookieName – the name of the cookie
{String} cookieValue – the value of the cookie
{String} domain – the domain
{String} path – the path

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setCookie

Unknown macro: {span}

(cookieName, cookieValue, domain, path, maxAge)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add cookie to the this client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCookie

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setCookie

Unknown macro: {span}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add cookie to the this client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setTimeout

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

setTimeout

Unknown macro: {span}

(msTimeout)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

msTimeout

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

client.setTimeout(1000)

Unknown macro: {tr}

Unknown macro: {td}

Child pages

HttpClient

createDeleteRequest

createGetRequest

createHeadRequest

createOptionsRequest

createPostRequest

createPutRequest

createTraceRequest

getCookie

getCookies

setClientProxyCredentials

setCookie

setCookie

setCookie

setCookie

setCookie

setTimeout