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:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types Details{th}{tr}{tr}{td}{span:class=sWordList}[Cookie]{span}{span:class=sWordList}[Poster]{span}{td}{tr}{table}\\ 

{table:id=|class=servoy sSummery}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method SummarySummery{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:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=9AB0E4D5-247B-4003-A728-9BD25C02A788createHttpClient|class=node}{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:9AB0E4D5-247B-4003-A728-9BD25C02A788createHttpClient_des|text=|trigger=button}{sub-section}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788createHttpClient_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}{trbuilder-show:idpermission=prsedit}{tr:id=snc}{td}*ParametersSince*\\{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_prscreateHttpClient_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_prscreateHttpClient_snc|trigger=none}http_clientname
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_retcreateHttpClient_prs|text=|trigger=button}{sub-section}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_retcreateHttpClient_prs|trigger=none|class=sIndent}voidhttp_clientname
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:tr:id=seeret}{td}*Also seeReturns*\\{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_seecreateHttpClient_ret|text=|trigger=button}{sub-section}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_seecreateHttpClient_ret|trigger=none|class=sIndent|trigger=none}void{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788createHttpClient_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_link|class=sIndentcreateHttpClient_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_samcreateHttpClient_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9AB0E4D5-247B-4003-A728-9BD25C02A788_sam|class=sIndent|trigger=none}{code:language=javascript}createHttpClient_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createHttpClient_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createHttpClient_sam|trigger=none}{code:language=javascript}
plugins.http.createHttpClient('mybrowser');
var pageData = plugins.http.getPageData('http://www.cnn.com','mybrowser','username','mypassword');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient|class=node}{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:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_des|text=|trigger=button}{sub-section}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9_prsdeleteHttpClient_snc|text=|trigger=button}{sub-section}{div:sub-section:deleteHttpClient_snc|trigger=none|class=sIndent}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9 Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:deleteHttpClient_prs|text=|trigger=button}{sub-section}{sub-section:deleteHttpClient_prs|trigger=none|class=sIndent}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_ret|text=|trigger=button}{sub-section}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9_see|deleteHttpClient_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9_seedeleteHttpClient_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:881E0B76-DF33-495B-BDC0-F68DAAEF17E9deleteHttpClient_sam|classtrigger=sIndent|trigger=none}{code:language=javascript}
plugins.http.deleteHttpClient('mybrowser');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=08564C38-113A-4473-8A1C-19201456DB9AgetHttpClientCookie|class=node}{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:08564C38-113A-4473-8A1C-19201456DB9AgetHttpClientCookie_des|text=|trigger=button}{sub-section}{sub-section:08564C38-113A-4473-8A1C-19201456DB9AgetHttpClientCookie_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_prsgetHttpClientCookie_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_prsgetHttpClientCookie_snc|trigger=none}clientName
cookieName
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_retgetHttpClientCookie_prs|text=|trigger=button}{sub-section}{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_retgetHttpClientCookie_prs|trigger=none|class=sIndent}[Cookie]clientName
cookieName
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_seegetHttpClientCookie_ret|text=|trigger=button}{sub-section}{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_seegetHttpClientCookie_ret|trigger=none|class=sIndent|trigger=none}}[Cookie]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:08564C38-113A-4473-8A1C-19201456DB9AgetHttpClientCookie_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_link|class=sIndentgetHttpClientCookie_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_samgetHttpClientCookie_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:08564C38-113A-4473-8A1C-19201456DB9A_sam|class=sIndentgetHttpClientCookie_link|trigger=none}{code:language=sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getHttpClientCookie_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHttpClientCookie_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=AF6136DF-EAAA-405E-ADF1-92FC9E478ABA=getHttpClientCookies|class=node}{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:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_des|getHttpClientCookies_des|text=|trigger=button}{sub-section}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABAgetHttpClientCookies_des|trigger=none|class=sIndent}Returns a Cookie array with all the cookies set on the specified client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_prsgetHttpClientCookies_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_prsgetHttpClientCookies_snc|trigger=none}clientName
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_retgetHttpClientCookies_prs|text=|trigger=button}{sub-section}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_retgetHttpClientCookies_prs|trigger=none|class=sIndent}[Cookie]\[]clientName
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_seegetHttpClientCookies_ret|text=|trigger=button}{sub-section}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_seegetHttpClientCookies_ret|trigger=none|class=sIndent|trigger=none}}[Cookie]\[]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABAgetHttpClientCookies_see|text=|trigger=button}{sub-section}{subdiv:class=sIndent}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_link|class=sIndentgetHttpClientCookies_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_samgetHttpClientCookies_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AF6136DF-EAAA-405E-ADF1-92FC9E478ABA_sam|class=sIndent|trigger=none}{code:language=getHttpClientCookies_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getHttpClientCookies_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHttpClientCookies_sam|trigger=none}{code:language=javascript}
var cookies = plugins.http.getHttpClientCookies('clientName')
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DC87FF7B-06C1-4589-8546-C2CE87AE7F00getLastPageCharset|class=node}{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:DC87FF7B-06C1-4589-8546-C2CE87AE7F00getLastPageCharset_des|text=|trigger=button}{sub-section}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00getLastPageCharset_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=prssnc}{td}*ParametersSince*\\{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_prsgetLastPageCharset_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_prsgetLastPageCharset_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_retgetLastPageCharset_prs|text=|trigger=button}{sub-section}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_retgetLastPageCharset_prs|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_seegetLastPageCharset_ret|text=|trigger=button}{sub-section}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_seegetLastPageCharset_ret|trigger=none|class=sIndent|trigger=none}}[String]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00getLastPageCharset_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_link|class=sIndent|getLastPageCharset_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_samgetLastPageCharset_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DC87FF7B-06C1-4589-8546-C2CE87AE7F00_sam|class=sIndentgetLastPageCharset_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLastPageCharset_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLastPageCharset_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C305791B-CEF0-4896-A17C-D1CAFBF66E70getMediaData|class=node}{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:C305791B-CEF0-4896-A17C-D1CAFBF66E70getMediaData_des|text=|trigger=button}{sub-section}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70getMediaData_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}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_prsgetMediaData_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_prsgetMediaData_snc|trigger=none}url
\[http_clientname\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_retgetMediaData_prs|text=|trigger=button}{sub-section}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_retgetMediaData_prs|trigger=none|class=sIndent}byte[]url
\[http\_clientname]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_seegetMediaData_ret|text=|trigger=button}{sub-section}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_seegetMediaData_ret|trigger=none|class=sIndent|trigger=none}}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70getMediaData_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_link|class=sIndentgetMediaData_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_samgetMediaData_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C305791B-CEF0-4896-A17C-D1CAFBF66E70_sam|class=sIndentgetMediaData_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getMediaData_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getMediaData_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=22496303-E14A-46D8-98C4-D4386A37AF30=getPageData|class=node}{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:22496303-E14A-46D8-98C4-D4386A37AF30getPageData_des|text=|trigger=button}{sub-section}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30getPageData_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}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_prsgetPageData_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_prsgetPageData_snc|trigger=none|class=sIndent}url
\[http_clientname\]
\[username\]
\[password\]
 Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_retgetPageData_prs|text=|trigger=button}{sub-section}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_retgetPageData_prs|trigger=none|class=sIndent}[String]url
\[http\_clientname]
\[username]
\[password]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_seegetPageData_ret|text=|trigger=button}{sub-section}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_seegetPageData_ret|trigger=none|class=sIndent|trigger=none}}[String]{sub-section}{td}{tr}{builder-show}{builder-show::permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30getPageData_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_link|class=sIndentgetPageData_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_samgetPageData_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:22496303-E14A-46D8-98C4-D4386A37AF30_sam|class=sIndentgetPageData_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getPageData_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPageData_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=E20A4659-D895-4FD6-A52E-38C0B4A3EBB9=getPoster|class=node}{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:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_getPoster_des|text=|trigger=button}{sub-section}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9getPoster_des|trigger=none|class=sIndent}Get poster object to do http (file) posts. If posting files, it will post multipart!{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_prsgetPoster_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_prsgetPoster_snc|trigger=none}url
\[http_clientname\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_retgetPoster_prs|text=|trigger=button}{sub-section}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_retgetPoster_prs|trigger=none|class=sIndent}[Poster]url
\[http\_clientname]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_seegetPoster_ret|text=|trigger=button}{sub-section}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_seegetPoster_ret|trigger=none|class=sIndent|trigger=none}}[Poster]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_see|getPoster_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_link|class=sIndentgetPoster_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_samgetPoster_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E20A4659-D895-4FD6-A52E-38C0B4A3EBB9_sam|class=sIndentgetPoster_link|trigger=none}{sub-section}{code:language=javascript}
var div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getPoster_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPoster_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=E9EB3128-F328-4A11-81EB-A9661D69AB9A=put|class=node}{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:E9EB3128-F328-4A11-81EB-A9661D69AB9Aput_des|text=|trigger=button}{sub-section}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9Aput_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_prsput_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_prsput_snc|trigger=none|class=sIndent}clientName urlReplace fileNamewith filePath
\[username\]
\[password\]
version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_retput_prs|text=|trigger=button}{sub-section}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_retput_prs|trigger=none|class=sIndent}[Boolean]clientName
url
fileName
filePath
\[username]
\[password]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_seeput_ret|text=|trigger=button}{sub-section}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_seeput_ret|trigger=none|class=sIndent|trigger=none}}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9Aput_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_link|class=sIndentput_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_samput_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E9EB3128-F328-4A11-81EB-A9661D69AB9A_sam|class=sIndentput_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:put_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:put_sam|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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A791095E-5B78-46A0-950C-00BB9C395B9B=setClientProxyUserNamePassword|class=node}{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:A791095E-5B78-46A0-950C-00BB9C395B9B_des|textsetClientProxyUserNamePassword_des|text=|trigger=button}{sub-section}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9BsetClientProxyUserNamePassword_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}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_prssetClientProxyUserNamePassword_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_prssetClientProxyUserNamePassword_snc|trigger=none}username
password
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_retsetClientProxyUserNamePassword_prs|text=|trigger=button}{sub-section}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_retsetClientProxyUserNamePassword_prs|trigger=none|class=sIndent}voidusername
password
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_seesetClientProxyUserNamePassword_ret|text=|trigger=button}{sub-section}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_seesetClientProxyUserNamePassword_ret|trigger=none|class=sIndent|trigger=none}void{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9BsetClientProxyUserNamePassword_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_link|class=sIndent|setClientProxyUserNamePassword_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_samsetClientProxyUserNamePassword_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A791095E-5B78-46A0-950C-00BB9C395B9B_sam|class=sIndentsetClientProxyUserNamePassword_link|trigger=none}{code:language=javascript}
plugins.}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setClientProxyUserNamePassword_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setClientProxyUserNamePassword_sam|trigger=none}{code:language=javascript}
plugins.http.setClientProxyUserNamePassword('my_proxy_username','my_proxy_password');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie|class=node}{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:6D95EBFC-62AD-4287-BC96-7ACB26E81702_dessetHttpClientCookie_des|text=|trigger=button}{sub-section}{sub-section:setHttpClientCookie_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setHttpClientCookie_snc|text=|trigger=button}{sub-section}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702_dessetHttpClientCookie_snc|trigger=none|class=sIndent}Add cookieReplace towith the specified client.version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_prs|trigger=none|class=sIndent}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_ret|text=|trigger=button}{sub-section}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702-section:setHttpClientCookie_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702_seesetHttpClientCookie_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6D95EBFC-62AD-4287-BC96-7ACB26E81702setHttpClientCookie_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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Child pages

Versions Compared

Old Version 11

New Version 12

Key
