Page History

Wiki Markup
{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{hidden}
{sub-section:description|text=}{sub-section}\\ 

{table:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[Cookie]{span}{span:class=sWordList}[Poster]{span}{td}{tr}{table}\\ 

{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#deleteHttpClient]\(http_clientname)
Delete a named http client.{td}{tr}{tbody}{tbody}{tr}{td}[Cookie]{td}{td}[#getHttpClientCookie]\(clientName, cookieName)
Get cookie object from the specified client.{td}{tr}{tbody}{tbody}{tr}{td}[Cookie]\[]{td}{td}[#getHttpClientCookies]\(clientName)
Returns a Cookie array with all the cookies set on the specified client.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getLastPageCharset]\()
Get the charset of the last page received with getPageData(.{td}{tr}{tbody}{tbody}{tr}{td}byte[]{td}{td}[#getMediaData]\(url, http_clientname)
Get media (binary data) such as images in a variable.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getPageData]\(url, http_clientname, username, password)
Get all page html in a variable (authentication only works with http client usage).{td}{tr}{tbody}{tbody}{tr}{td}[Poster]{td}{td}[#getPoster]\(url, http_clientname)
Get poster object to do http (file) posts.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#put]\(clientName, url, fileName, filePath, username, password)
Put a file at the specified URL.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setClientProxyUserNamePassword]\(username, password)
Set the proxy username and password.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setHttpClientCookie]\(clientName, cookieName, cookieValue, domain, path, maxAge, secure)
Add cookie to the specified client.{td}{tr}{tbody}{table}\\ 

{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D}{tr:id=name}{td}h6.createHttpClient{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}createHttpClient{span}{span:id=iets|style=float: left;}\(http_clientname){span}{td}{tr}{tr:id=des}{td}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_des|text=|trigger=button}{sub-section}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_des|trigger=none|class=sIndent}Create a named http client (like a web browser with session binding) usable todo multiple request/posts in same server session.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_ret|text=|trigger=button}{sub-section}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_see|text=|trigger=button}{sub-section}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_see|text=|trigger=button}{sub-section}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_sam|text=|trigger=button}{sub-section}{sub-section:D17453DBB4AAC8D8-3F2621B6-4B984A0A-BB0F9E7A-70D79B1904B42DFD0AB31B8D_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.http.createHttpClient('mybrowser');
var pageData = plugins.http.getPageData('http://www.cnn.com','mybrowser','username','mypassword');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF}{tr:id=name}{td}h6.deleteHttpClient{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}deleteHttpClient{span}{span:id=iets|style=float: left;}\(http_clientname){span}{td}{tr}{tr:id=des}{td}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_des|text=|trigger=button}{sub-section}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_ret|text=|trigger=button}{sub-section}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_see|text=|trigger=button}{sub-section}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_see|text=|trigger=button}{sub-section}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_sam|text=|trigger=button}{sub-section}{sub-section:59DFE66C01997DFD-4BD322DE-4F7C4F2C-B33A9656-BDB6BFA6954F1A0E65936BCF_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.http.deleteHttpClient('mybrowser');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52}{tr:id=name}{td}h6.getHttpClientCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Cookie]{span}{span:id=iets|style=float: left; font-weight: bold;}getHttpClientCookie{span}{span:id=iets|style=float: left;}\(clientName, cookieName){span}{td}{tr}{tr:id=des}{td}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_des|text=|trigger=button}{sub-section}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_ret|text=|trigger=button}{sub-section}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_see|text=|trigger=button}{sub-section}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_see|text=|trigger=button}{sub-section}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_sam|text=|trigger=button}{sub-section}{sub-section:8EBD5016C2257288-385EB201-4EF845A1-9CCEA83E-87EF07A12FB9616A560ABC52_sam|class=sIndent|trigger=none}{code:language=javascript}
var cookie = plugins.http.getHttpClientCookie('clientName', 'JSESSIONID');
if (cookie != null)
{
	// do something
}
else
	plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0}{tr:id=name}{td}h6.getHttpClientCookies{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Cookie]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getHttpClientCookies{span}{span:id=iets|style=float: left;}\(clientName){span}{td}{tr}{tr:id=des}{td}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_des|text=|trigger=button}{sub-section}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_des|trigger=none|class=sIndent}Returns a Cookie array with all the cookies set on the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_ret|text=|trigger=button}{sub-section}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_see|text=|trigger=button}{sub-section}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_see|text=|trigger=button}{sub-section}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_sam|text=|trigger=button}{sub-section}{sub-section:3966F398DC09F63B-6C50DF81-433F4F51-BD8CAC54-8F34DB2A3DCCABB0733C6CC0_sam|class=sIndent|trigger=none}{code:language=javascript}
var cookies = plugins.http.getHttpClientCookies('clientName')
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2}{tr:id=name}{td}h6.getLastPageCharset{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getLastPageCharset{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_des|text=|trigger=button}{sub-section}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_des|trigger=none|class=sIndent}Get the charset of the last page received with getPageData(...){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_ret|text=|trigger=button}{sub-section}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_see|text=|trigger=button}{sub-section}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_see|text=|trigger=button}{sub-section}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_sam|text=|trigger=button}{sub-section}{sub-section:4294E776B64AAC68-E3B55B6D-425A4380-99659B6C-8F70A04E13BD63AA75CBC6C2_sam|class=sIndent|trigger=none}{code: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');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344}{tr:id=name}{td}h6.getMediaData{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}byte[]{span}{span:id=iets|style=float: left; font-weight: bold;}getMediaData{span}{span:id=iets|style=float: left;}\(url, http_clientname){span}{td}{tr}{tr:id=des}{td}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_des|text=|trigger=button}{sub-section}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_des|trigger=none|class=sIndent}Get media (binary data) such as images in a variable. It also supports gzip-ed content.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_ret|text=|trigger=button}{sub-section}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_see|text=|trigger=button}{sub-section}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_see|text=|trigger=button}{sub-section}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_sam|text=|trigger=button}{sub-section}{sub-section:6D188AA9E74501A1-B93B81E4-438441D5-ACCAA3CD-5A0615203B0DAA5859FF9344_sam|class=sIndent|trigger=none}{code: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');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07}{tr:id=name}{td}h6.getPageData{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getPageData{span}{span:id=iets|style=float: left;}\(url, http_clientname, username, password){span}{td}{tr}{tr:id=des}{td}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_des|text=|trigger=button}{sub-section}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_ret|text=|trigger=button}{sub-section}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_see|text=|trigger=button}{sub-section}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_see|text=|trigger=button}{sub-section}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_sam|text=|trigger=button}{sub-section}{sub-section:8FE4681EE58E06A7-303573F6-4E2D4849-99D1B419-6B65FAAA723539AD32F2DD07_sam|class=sIndent|trigger=none}{code: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');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6}{tr:id=name}{td}h6.getPoster{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Poster]{span}{span:id=iets|style=float: left; font-weight: bold;}getPoster{span}{span:id=iets|style=float: left;}\(url, http_clientname){span}{td}{tr}{tr:id=des}{td}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_des|text=|trigger=button}{sub-section}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_des|trigger=none|class=sIndent}Get poster object to do http (file) posts. If posting files, it will post multipart!{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_ret|text=|trigger=button}{sub-section}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_see|text=|trigger=button}{sub-section}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_see|text=|trigger=button}{sub-section}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_sam|text=|trigger=button}{sub-section}{sub-section:23E10C28AD9E2D1B-159BE657-48F344FE-B11DBBCB-B1EDFE81ED3E04399DA487B6_sam|class=sIndent|trigger=none}{code: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()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD}{tr:id=name}{td}h6.put{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}put{span}{span:id=iets|style=float: left;}\(clientName, url, fileName, filePath, username, password){span}{td}{tr}{tr:id=des}{td}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_des|text=|trigger=button}{sub-section}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_ret|text=|trigger=button}{sub-section}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_see|text=|trigger=button}{sub-section}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_see|text=|trigger=button}{sub-section}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_sam|text=|trigger=button}{sub-section}{sub-section:A830D2FF1827B893-0E6518F9-41E840D9-8607A907-0640EBE38608D8AA953B15FD_sam|class=sIndent|trigger=none}{code:language=javascript}
var fileAdded = plugins.http.put('clientName', 'http://www.abc.com/put_stuff.jsp', 'manual.doc', 'c:/temp/manual_01a.doc', 'user', 'password')
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE}{tr:id=name}{td}h6.setClientProxyUserNamePassword{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setClientProxyUserNamePassword{span}{span:id=iets|style=float: left;}\(username, password){span}{td}{tr}{tr:id=des}{td}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_des|text=|trigger=button}{sub-section}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_des|trigger=none|class=sIndent}Set the proxy username and password. Used for named http clients ( else use implicit java data).{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_ret|text=|trigger=button}{sub-section}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_see|text=|trigger=button}{sub-section}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_see|text=|trigger=button}{sub-section}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_sam|text=|trigger=button}{sub-section}{sub-section:BDED5A6A972205AF-3F65FE69-4F8A48B9-BA05AD88-1D6DE05AD6A0B442304D31CE_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.http.setClientProxyUserNamePassword('my_proxy_username','my_proxy_password');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE}{tr:id=name}{td}h6.setHttpClientCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setHttpClientCookie{span}{span:id=iets|style=float: left;}\(clientName, cookieName, cookieValue, domain, path, maxAge, secure){span}{td}{tr}{tr:id=des}{td}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_des|text=|trigger=button}{sub-section}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_ret|text=|trigger=button}{sub-section}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_see|text=|trigger=button}{sub-section}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_see|text=|trigger=button}{sub-section}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_sam|text=|trigger=button}{sub-section}{sub-section:989CC2B7102710C1-70ED9809-43BE4A82-B3749911-B0FC51DC9403578A4D5172DE_sam|class=sIndent|trigger=none}{code:language=javascript}
var cookieSet = plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
	//do something
}
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Child pages

Versions Compared

Old Version 9

New Version 10

Key
