Page History

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'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
DeleteRequest

...

Table Cell (td)
GetRequest

...

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods Summaryvoidreleases all resources that this client has, should be called after usage.Creates a new delete request (a request to delete a resource on server).

...

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

...

Table Cell (td)
HeadRequest

...

Table Cell (td)
OptionsRequest

...

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

...

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

...

Table Cell (td)
PostRequest

...

Table Cell (td)
PutRequest

...

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

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

...

Table Cell (td)
TraceRequest

...

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

...

Table Cell (td)
Cookie

...

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

...

Table Cell (td)
Cookie[]

...

Get a cookie by name.

...

Get all cookies from this client.

...

void

...

Set proxy credentials

...

Table Cell (td)
Boolean

...

.

void

Set proxy server.

Add cookie to the this client.

...

Table Cell (td)
Boolean

...

Add cookie to the this client.

...

Table Cell (td)
Boolean

...

Add cookie to the this client.

...

Table Cell (td)
Boolean

...

Add cookie to the this client.

...

Table Cell (td)
Boolean

...

Add cookie to the this client.

...

void

...

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

...

function

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

Table Head (th)

colspan	1

Method Details

...

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

...

class	lastDetailRow

...

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)

...

id	des

...

class	sIndent

...

2

Methods Details

close

name

close()

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createDeleteRequest

name

createDeleteRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createGetRequest

name

createGetRequest(url)

des

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

...

prs

...

Parameters

...

sIndent

...

id	ret

url

;

ret

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

Sample

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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)

...

id	des

...

class	sIndent

...

sIdent

javascript

lastDetailRow

createHeadRequest

name

createHeadRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createOptionsRequest

name

createOptionsRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createPatchRequest

name

createPatchRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createPostRequest

name

createPostRequest(url)

des

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

...

prs

...

Parameters

...

sIndent

...

id	ret

url

;

ret

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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)

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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
}

...

class	lastDetailRow

...

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
}

...

class	lastDetailRow

...

id	setCookie-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
setCookie

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

...

SmartClient,WebClient,NGClient

sam

Sample

...

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

sIdent

javascript

lastDetailRow

createPutRequest

name

createPutRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createTraceRequest

name

createTraceRequest(url)

des

sIndent

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

prs

Parameters

sIndent

url

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCookie

name

getCookie(cookieName)

des

sIndent

Get a cookie by name.

prs

Parameters

sIndent

cookieName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCookies

name

getCookies()

des

sIndent

Get all cookies from this client.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setClientProxyCredentials

name

setClientProxyCredentials(userName, password)

des

sIndent

Set proxy credentials.

prs

Parameters

sIndent

userName

;

password

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setClientProxyServer

name

setClientProxyServer(hostname, port)

des

sIndent

Set proxy server.

prs

Parameters

sIndent

hostname

- proxy host // null value will clear proxyHost settings;

port

- proxy port //null value will clear proxyHost settings;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setCookie

name

setCookie(cookieName, cookieValue)

des

sIndent

Add cookie to the this client.

prs

Parameters

sIndent

cookieName

the name of the cookie

cookieValue

the value of the cookie

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setCookie

name

setCookie(cookieName, cookieValue, domain)

des

sIndent

Add cookie to the this client.

prs

Parameters

sIndent

cookieName

the name of the cookie

cookieValue

the value of the cookie

domain

the domain

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setCookie

name

setCookie(cookieName, cookieValue, domain, path)

...

des

...

sIndent

Add cookie to the this client.

...

prs

...

Parameters

...

sIndent

...

cookieName

...

the name of the cookie

...

cookieValue

...

the value of the cookie

...

domain

...

the domain

...

path

...

the path

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

...

Sample

...

class	sIndent

...

Code Block

language	javascript

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

...

class	lastDetailRow

...

id	setCookie-String_String_String_String_Number

Table Row (tr)

id	name

Table Cell (td)
setCookie

...

id	sig

...

sIdent

javascript

lastDetailRow

setCookie

name

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

...

des

...

sIndent

Add cookie to the this client.

...

prs

...

Parameters

...

sIndent

...

cookieName

...

the name of the cookie

...

cookieValue

...

the value of the cookie

...

domain

...

the domain

...

path

...

the path

...

maxAge

...

maximum age of cookie

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

setCookie

...

SmartClient,WebClient,NGClient

sam

Sample

...

class	sIndent

...

Code Block

language	javascript

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

...

class	lastDetailRow

...

id	setCookie-String_String_String_String_Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
setCookie

...

id	sig

...

sIdent

javascript

lastDetailRow

setCookie

name

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

...

des

...

sIndent

Add cookie to the this client.

...

prs

...

Parameters

...

sIndent

...

cookieName

...

the name of the cookie

...

cookieValue

...

the value of the cookie

...

domain

...

the domain

...

path

...

the path

...

maxAge

...

maximum age of cookie

...

secure

...

true if it is a secure cookie, false otherwise

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

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)

...

class	lastDetailRow

...

Sample

...

class	sIndent

...

Code Block

language	javascript

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

sIdent

javascript

lastDetailRow

setTimeout

name

setTimeout(msTimeout)

des

sIndent

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

prs

Parameters

sIndent

msTimeout

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 12

New Version Current

Key

createDeleteRequest

createGetRequest

close()

createDeleteRequest(url)

createGetRequest(url)

createHeadRequest

createOptionsRequest

createPostRequest

createHeadRequest(url)

createOptionsRequest(url)

createPatchRequest(url)

createPostRequest(url)

createPutRequest

createTraceRequest

getCookie

getCookies

setClientProxyCredentials

setCookie

setCookie

setCookie

createPutRequest(url)

createTraceRequest(url)

getCookie(cookieName)

getCookies()

setClientProxyCredentials(userName, password)

setClientProxyServer(hostname, port)

setCookie(cookieName, cookieValue)

setCookie(cookieName, cookieValue, domain)

setCookie(cookieName, cookieValue, domain, path)

des

setCookie

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

setCookie

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

des

setTimeout

setTimeout(msTimeout)