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=B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788}{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:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_des|text=|trigger=button}{sub-section}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_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:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_ret|text=|trigger=button}{sub-section}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_see|text=|trigger=button}{sub-section}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_see|text=|trigger=button}{sub-section}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_sam|text=|trigger=button}{sub-section}{sub-section:B4AAC8D89AB0E4D5-21B6247B-4A0A4003-9E7AA728-2DFD0AB31B8D9BD25C02A788_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=01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9}{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:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_des|text=|trigger=button}{sub-section}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_ret|text=|trigger=button}{sub-section}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_see|text=|trigger=button}{sub-section}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_see|text=|trigger=button}{sub-section}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_sam|text=|trigger=button}{sub-section}{sub-section:01997DFD881E0B76-22DEDF33-4F2C495B-9656BDC0-1A0E65936BCFF68DAAEF17E9_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=C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A}{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:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_des|text=|trigger=button}{sub-section}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_ret|text=|trigger=button}{sub-section}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_see|text=|trigger=button}{sub-section}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_see|text=|trigger=button}{sub-section}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_sam|text=|trigger=button}{sub-section}{sub-section:C225728808564C38-B201113A-45A14473-A83E8A1C-616A560ABC5219201456DB9A_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=DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA}{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:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_des|text=|trigger=button}{sub-section}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_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:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_ret|text=|trigger=button}{sub-section}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_see|text=|trigger=button}{sub-section}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_see|text=|trigger=button}{sub-section}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_sam|text=|trigger=button}{sub-section}{sub-section:DC09F63BAF6136DF-DF81EAAA-4F51405E-AC54ADF1-ABB0733C6CC092FC9E478ABA_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=B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00}{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:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_des|text=|trigger=button}{sub-section}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_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:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_ret|text=|trigger=button}{sub-section}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_see|text=|trigger=button}{sub-section}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_see|text=|trigger=button}{sub-section}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_sam|text=|trigger=button}{sub-section}{sub-section:B64AAC68DC87FF7B-5B6D06C1-43804589-9B6C8546-63AA75CBC6C2C2CE87AE7F00_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=E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70}{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:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_des|text=|trigger=button}{sub-section}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_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:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_ret|text=|trigger=button}{sub-section}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_see|text=|trigger=button}{sub-section}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_see|text=|trigger=button}{sub-section}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_sam|text=|trigger=button}{sub-section}{sub-section:E74501A1C305791B-81E4CEF0-41D54896-A3CDA17C-AA5859FF9344D1CAFBF66E70_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=E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30}{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:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_des|text=|trigger=button}{sub-section}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_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:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_ret|text=|trigger=button}{sub-section}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_see|text=|trigger=button}{sub-section}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_see|text=|trigger=button}{sub-section}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_sam|text=|trigger=button}{sub-section}{sub-section:E58E06A722496303-73F6E14A-484946D8-B41998C4-39AD32F2DD07D4386A37AF30_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=AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9}{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:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_des|text=|trigger=button}{sub-section}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_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:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_ret|text=|trigger=button}{sub-section}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_see|text=|trigger=button}{sub-section}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_see|text=|trigger=button}{sub-section}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_sam|text=|trigger=button}{sub-section}{sub-section:AD9E2D1BE20A4659-E657D895-44FE4FD6-BBCBA52E-04399DA487B638C0B4A3EBB9_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=1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A}{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:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_des|text=|trigger=button}{sub-section}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_ret|text=|trigger=button}{sub-section}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_see|text=|trigger=button}{sub-section}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_see|text=|trigger=button}{sub-section}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_sam|text=|trigger=button}{sub-section}{sub-section:1827B893E9EB3128-18F9F328-40D94A11-A90781EB-D8AA953B15FDA9661D69AB9A_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=972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B}{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:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_des|text=|trigger=button}{sub-section}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_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:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_ret|text=|trigger=button}{sub-section}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_see|text=|trigger=button}{sub-section}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_see|text=|trigger=button}{sub-section}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_sam|text=|trigger=button}{sub-section}{sub-section:972205AFA791095E-FE695B78-48B946A0-AD88950C-B442304D31CE00BB9C395B9B_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=102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702}{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:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_des|text=|trigger=button}{sub-section}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_ret|text=|trigger=button}{sub-section}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_see|text=|trigger=button}{sub-section}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_see|text=|trigger=button}{sub-section}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_sam|text=|trigger=button}{sub-section}{sub-section:102710C16D95EBFC-980962AD-4A824287-9911BC96-578A4D5172DE7ACB26E81702_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 10

New Version 11

Key
