Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

Cookie

Span

class	sWordList

Poster

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#createHttpClient(http_clientname) Create a named http client (like a web browser with session binding) usable todo multiple request/posts in same server session.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#deleteHttpClient(http_clientname) Delete a named http client.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Cookie

Table Cell (td)
#getHttpClientCookie(clientName, cookieName) Get cookie object from the specified client.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Cookie[]

Table Cell (td)
#getHttpClientCookies(clientName) Returns a Cookie array with all the cookies set on the specified client.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getLastPageCharset() Get the charset of the last page received with getPageData(.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
byte[]

Table Cell (td)
#getMediaData(url, [http_clientname]) Get media (binary data) such as images in a variable.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getPageData(url, [http_clientname], [username], [password]) Get all page html in a variable (authentication only works with http client usage).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Poster

Table Cell (td)
#getPoster(url, [http_clientname]) Get poster object to do http (file) posts.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#put(clientName, url, fileName, filePath, [username], [password]) Put a file at the specified URL.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setClientProxyUserNamePassword(username, password) Set the proxy username and password.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#setHttpClientCookie(clientName, cookieName, cookieValue, [domain], [path], [maxAge], [secure]) Add cookie to the specified client.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	createHttpClient
class	node

Table Row (tr)

id	name

Table Cell (td)
createHttpClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

createHttpClient

Span

style	float: left;
id	iets

(http_clientname)

Table Row (tr)

id	des

Table Cell (td)
Create a named http client (like a web browser with session binding) usable todo multiple request/posts in same server session.

Table Row (tr)

id	prs

Table Cell (td)
Parameters http_clientname

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.http.createHttpClient('mybrowser');
var pageData = plugins.http.getPageData('http://www.cnn.com','mybrowser','username','mypassword');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteHttpClient
class	node

Table Row (tr)

id	name

Table Cell (td)
deleteHttpClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

deleteHttpClient

Span

style	float: left;
id	iets

(http_clientname)

Table Row (tr)

id	des

Table Cell (td)
Delete a named http client.

Table Row (tr)

id	prs

Table Cell (td)
Parameters http_clientname

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.http.deleteHttpClient('mybrowser');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getHttpClientCookie
class	node

Table Row (tr)

id	name

Table Cell (td)
getHttpClientCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Cookie

Span

style	float: left; font-weight: bold;
id	iets

getHttpClientCookie

Span

style	float: left;
id	iets

(clientName, cookieName)

Table Row (tr)

id	des

Table Cell (td)
Get cookie object from the specified client.

Table Row (tr)

id	prs

Table Cell (td)
Parameters clientName cookieName

Table Row (tr)

id	ret

Table Cell (td)
Returns Cookie

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var cookie = plugins.http.getHttpClientCookie('clientName', 'JSESSIONID');
if (cookie != null)
{
	// do something
}
else
	plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getHttpClientCookies
class	node

Table Row (tr)

id	name

Table Cell (td)
getHttpClientCookies

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Cookie[]

Span

style	float: left; font-weight: bold;
id	iets

getHttpClientCookies

Span

style	float: left;
id	iets

(clientName)

Table Row (tr)

id	des

Table Cell (td)
Returns a Cookie array with all the cookies set on the specified client.

Table Row (tr)

id	prs

Table Cell (td)
Parameters clientName

Table Row (tr)

id	ret

Table Cell (td)
Returns Cookie[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var cookies = plugins.http.getHttpClientCookies('clientName')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLastPageCharset
class	node

Table Row (tr)

id	name

Table Cell (td)
getLastPageCharset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getLastPageCharset

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get the charset of the last page received with getPageData(...)

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var a = plugins.http.getPageData('http://www.google.com.hk');
var charset = plugins.http.getLastPageCharset();
var success = plugins.file.writeTXTFile('someFilePath', a, charset);
if (!success) plugins.dialogs.showWarningDialog('Warning', 'Could not write file', 'OK');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMediaData
class	node

Table Row (tr)

id	name

Table Cell (td)
getMediaData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

byte[]

Span

style	float: left; font-weight: bold;
id	iets

getMediaData

Span

style	float: left;
id	iets

(url, [http_clientname])

Table Row (tr)

id	des

Table Cell (td)
Get media (binary data) such as images in a variable. It also supports gzip-ed content.

Table Row (tr)

id	prs

Table Cell (td)
Parameters url [http_clientname]

Table Row (tr)

id	ret

Table Cell (td)
Returns byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var image_byte_array = plugins.http.getMediaData('http://www.cnn.com/cnn.gif');
var image_byte_array2 = plugins.http.getMediaData('http://www.cnn.com/cnn.gif', 'clientName');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPageData
class	node

Table Row (tr)

id	name

Table Cell (td)
getPageData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getPageData

Span

style	float: left;
id	iets

(url, [http_clientname], [username], [password])

Table Row (tr)

id	des

Table Cell (td)
Get all page html in a variable (authentication only works with http client usage). If name is provided a http client will be created/used.

Table Row (tr)

id	prs

Table Cell (td)
Parameters url [http_clientname] [username] [password]

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get data using a default connection
var pageData = plugins.http.getPageData('http://www.cnn.com');
// create an http client and use it to get the data
var pageData = plugins.http.getPageData('http://www.cnn.com','myclient');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPoster
class	node

Table Row (tr)

id	name

Table Cell (td)
getPoster

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Poster

Span

style	float: left; font-weight: bold;
id	iets

getPoster

Span

style	float: left;
id	iets

(url, [http_clientname])

Table Row (tr)

id	des

Table Cell (td)
Get poster object to do http (file) posts. If posting files, it will post multipart!

Table Row (tr)

id	prs

Table Cell (td)
Parameters url [http_clientname]

Table Row (tr)

id	ret

Table Cell (td)
Returns Poster

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var poster = plugins.http.getPoster('http://www.abc.com/apply_form.jsp');
var didAddParam = poster.addParameter('myParamName','myValue');
var didAddFile = poster.addFile('myFileParamName','manual.doc','c:/temp/manual_01a.doc');
var httpCode = poster.doPost('username','mypassword'); //httpCode 200 is ok
//var httpCode = poster.doPost('username','mypassword'); //use if authentication is needed
var pageData = poster.getPageData()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	put
class	node

Table Row (tr)

id	name

Table Cell (td)
put

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

put

Span

style	float: left;
id	iets

(clientName, url, fileName, filePath, [username], [password])

Table Row (tr)

id	des

Table Cell (td)
Put a file at the specified URL.

Table Row (tr)

id	prs

Table Cell (td)
Parameters clientName url fileName filePath [username] [password]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileAdded = plugins.http.put('clientName', 'http://www.abc.com/put_stuff.jsp', 'manual.doc', 'c:/temp/manual_01a.doc', 'user', 'password')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setClientProxyUserNamePassword
class	node

Table Row (tr)

id	name

Table Cell (td)
setClientProxyUserNamePassword

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setClientProxyUserNamePassword

Span

style	float: left;
id	iets

(username, password)

Table Row (tr)

id	des

Table Cell (td)
Set the proxy username and password. Used for named http clients ( else use implicit java data).

Table Row (tr)

id	prs

Table Cell (td)
Parameters username password

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.http.setClientProxyUserNamePassword('my_proxy_username','my_proxy_password');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setHttpClientCookie
class	node

Table Row (tr)

id	name

Table Cell (td)
setHttpClientCookie

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

setHttpClientCookie

Span

style	float: left;
id	iets

(clientName, cookieName, cookieValue, [domain], [path], [maxAge], [secure])

Table Row (tr)

id	des

Table Cell (td)
Add cookie to the specified client.

Table Row (tr)

id	prs

Table Cell (td)
Parameters clientName cookieName cookieValue [domain] [path] [maxAge] [secure]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var cookieSet = plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 14

New Version Current

Key

createHttpClient

deleteHttpClient

getHttpClientCookie

getHttpClientCookies

getLastPageCharset

getMediaData

getPageData

getPoster

put

setClientProxyUserNamePassword

setHttpClientCookie