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=4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729}{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:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_des|text=|trigger=button}{sub-section}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_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:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_ret|text=|trigger=button}{sub-section}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_see|text=|trigger=button}{sub-section}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_see|text=|trigger=button}{sub-section}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_sam|text=|trigger=button}{sub-section}{sub-section:4C6E481C2E595C0E-0FDF0B51-4E7240E8-B6618E28-BF9732B12FAAF25319854729_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=B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82}{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:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_des|text=|trigger=button}{sub-section}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_ret|text=|trigger=button}{sub-section}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_see|text=|trigger=button}{sub-section}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_see|text=|trigger=button}{sub-section}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_sam|text=|trigger=button}{sub-section}{sub-section:B4F1086E2C42621D-5BC2E123-44DB4B02-88EEBE5A-16133A153B4FAF910FA81E82_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=D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C}{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:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_des|text=|trigger=button}{sub-section}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_ret|text=|trigger=button}{sub-section}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_see|text=|trigger=button}{sub-section}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_see|text=|trigger=button}{sub-section}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_sam|text=|trigger=button}{sub-section}{sub-section:D17826CB7F692868-5A6959AA-4382403D-B6B2A802-AA48FCB13099F1E27E32107C_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=D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE}{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:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_des|text=|trigger=button}{sub-section}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_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:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_ret|text=|trigger=button}{sub-section}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_see|text=|trigger=button}{sub-section}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_see|text=|trigger=button}{sub-section}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_sam|text=|trigger=button}{sub-section}{sub-section:D94A019C28576A6B-CAD21BBD-45B14E2E-B2058A68-24B3F0C837A3944A96410BBE_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=C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394}{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:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_des|text=|trigger=button}{sub-section}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_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:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_ret|text=|trigger=button}{sub-section}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_see|text=|trigger=button}{sub-section}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_see|text=|trigger=button}{sub-section}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_sam|text=|trigger=button}{sub-section}{sub-section:C0090DE6D4EF7D8A-E3343DFE-453A44C7-839EA9EA-D6BBEA58D38740E19B638394_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=C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C}{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:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_des|text=|trigger=button}{sub-section}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_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:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_ret|text=|trigger=button}{sub-section}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_see|text=|trigger=button}{sub-section}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_see|text=|trigger=button}{sub-section}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_sam|text=|trigger=button}{sub-section}{sub-section:C563739CF43331CF-74E3B83E-43C64E69-9E8EA64B-2BBFBB74E0941C1F9E97855C_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=B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB}{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:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_des|text=|trigger=button}{sub-section}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_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:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_ret|text=|trigger=button}{sub-section}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_see|text=|trigger=button}{sub-section}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_see|text=|trigger=button}{sub-section}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_sam|text=|trigger=button}{sub-section}{sub-section:B997C68216F5F293-55825382-457446B0-AC88912E-B55E84BE1F1105EB6B8A95AB_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=EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C}{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:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_des|text=|trigger=button}{sub-section}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_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:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_ret|text=|trigger=button}{sub-section}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_see|text=|trigger=button}{sub-section}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_see|text=|trigger=button}{sub-section}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_sam|text=|trigger=button}{sub-section}{sub-section:EE7C055572EEA732-146FBEF9-40E142D5-9998AECD-760AB1BD1F43B1DA9337632C_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=03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E}{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:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_des|text=|trigger=button}{sub-section}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_ret|text=|trigger=button}{sub-section}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_see|text=|trigger=button}{sub-section}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_see|text=|trigger=button}{sub-section}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_sam|text=|trigger=button}{sub-section}{sub-section:03BBD78084ADB721-96963C12-46B94B3C-A3EEB364-E8100B8F809AB71D3520CB8E_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=CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02}{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:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_des|text=|trigger=button}{sub-section}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_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:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_ret|text=|trigger=button}{sub-section}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_see|text=|trigger=button}{sub-section}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_see|text=|trigger=button}{sub-section}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_sam|text=|trigger=button}{sub-section}{sub-section:CE10026D6F9DA275-E8D22225-4CF94633-B31BA746-6F3C7331FB787F290E34DB02_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=E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082}{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:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_des|text=|trigger=button}{sub-section}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_ret|text=|trigger=button}{sub-section}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_see|text=|trigger=button}{sub-section}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_see|text=|trigger=button}{sub-section}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_sam|text=|trigger=button}{sub-section}{sub-section:E9138ACB7ACCC841-B5369201-483F49F1-BCAC98DB-2E3E2B9A88DE8FAE6E6D7082_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 4

New Version 5

Key
