Page History

Div

style	display:none

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.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
DeleteRequest

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

Table Row (tr)

Table Cell (td)
GetRequest

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

Table Row (tr)

Table Cell (td)
HeadRequest

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

Table Row (tr)

Table Cell (td)
OptionsRequest

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

Table Row (tr)

Table Cell (td)
PostRequest

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

Table Row (tr)

Table Cell (td)
PutRequest

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

Table Row (tr)

Table Cell (td)
TraceRequest

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

Table Row (tr)

Table Cell (td)
Cookie

Table Cell (td)
getCookie(cookieName) Get a cookie by name.

Table Row (tr)

Table Cell (td)
Cookie[]

Table Cell (td)
getCookies() Get all cookies from this client.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setClientProxyCredentials(userName, password) Set proxy credentials.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
void

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

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	createDeleteRequest-String

Table Row (tr)

id	name

Table Cell (td)
createDeleteRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

DeleteRequest

Span

style	font-weight: bold;

createDeleteRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

DeleteRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createGetRequest-String

Table Row (tr)

id	name

Table Cell (td)
createGetRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

GetRequest

Span

style	font-weight: bold;

createGetRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

GetRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createHeadRequest-String

Table Row (tr)

id	name

Table Cell (td)
createHeadRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

HeadRequest

Span

style	font-weight: bold;

createHeadRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

HeadRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createOptionsRequest-String

Table Row (tr)

id	name

Table Cell (td)
createOptionsRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

OptionsRequest

Span

style	font-weight: bold;

createOptionsRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

OptionsRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPostRequest-String

Table Row (tr)

id	name

Table Cell (td)
createPostRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

PostRequest

Span

style	font-weight: bold;

createPostRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

PostRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPutRequest-String

Table Row (tr)

id	name

Table Cell (td)
createPutRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

PutRequest

Span

style	font-weight: bold;

createPutRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

PutRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createTraceRequest-String

Table Row (tr)

id	name

Table Cell (td)
createTraceRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

TraceRequest

Span

style	font-weight: bold;

createTraceRequest

Span
(url)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} url

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

TraceRequest

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCookie-String

Table Row (tr)

id	name

Table Cell (td)
getCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Cookie

Span

style	font-weight: bold;

getCookie

Span
(cookieName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a cookie by name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} cookieName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Cookie

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCookies

Table Row (tr)

id	name

Table Cell (td)
getCookies

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Cookie[]

Span

style	font-weight: bold;

getCookies

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get all cookies from this client.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Cookie[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var cookies = client.getHttpClientCookies()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setClientProxyCredentials-String_String

Table Row (tr)

id	name

Table Cell (td)
setClientProxyCredentials

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setClientProxyCredentials

Span
(userName, password)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set proxy credentials.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} userName
{String} password

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setCookie-String_String

Table Row (tr)

id	name

Table Cell (td)
setCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

Span
(cookieName, cookieValue)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add cookie to the this client.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setCookie-String_String_String

Table Row (tr)

id	name

Table Cell (td)
setCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

Span
(cookieName, cookieValue, domain)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add cookie to the this client.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setCookie-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
setCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

Span
(cookieName, cookieValue, domain, path)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add cookie to the this client.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setCookie-String_String_String_String_Number

Table Row (tr)

id	name

Table Cell (td)
setCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add cookie to the this client.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setCookie-String_String_String_String_Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
setCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add cookie to the this client.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setTimeout-

Table Row (tr)

id	name

Table Cell (td)
setTimeout

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setTimeout

Span
(msTimeout)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

msTimeout

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

client.setTimeout(1000)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 14

New Version Current

Key

createDeleteRequest

createGetRequest

createHeadRequest

createOptionsRequest

createPostRequest

createPutRequest

createTraceRequest

getCookie

getCookies

setClientProxyCredentials

setCookie

setCookie

setCookie

setCookie

setCookie

setTimeout