{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=9D967896-DB9B-4FA0-948E-E029F8B2FA93}{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:9D967896-DB9B-4FA0-948E-E029F8B2FA93_des|text=|trigger=button}{sub-section}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_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:9D967896-DB9B-4FA0-948E-E029F8B2FA93_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_ret|text=|trigger=button}{sub-section}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_see|text=|trigger=button}{sub-section}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_see|text=|trigger=button}{sub-section}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_sam|text=|trigger=button}{sub-section}{sub-section:9D967896-DB9B-4FA0-948E-E029F8B2FA93_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=CA3681F5-89B5-4032-8757-8B84FB75D2B2}{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:CA3681F5-89B5-4032-8757-8B84FB75D2B2_des|text=|trigger=button}{sub-section}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_ret|text=|trigger=button}{sub-section}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_see|text=|trigger=button}{sub-section}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_see|text=|trigger=button}{sub-section}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_sam|text=|trigger=button}{sub-section}{sub-section:CA3681F5-89B5-4032-8757-8B84FB75D2B2_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=8F152637-A9BB-40C7-B655-4214F1964DAD}{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:8F152637-A9BB-40C7-B655-4214F1964DAD_des|text=|trigger=button}{sub-section}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_ret|text=|trigger=button}{sub-section}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_see|text=|trigger=button}{sub-section}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_see|text=|trigger=button}{sub-section}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_sam|text=|trigger=button}{sub-section}{sub-section:8F152637-A9BB-40C7-B655-4214F1964DAD_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=50B57025-60C4-477A-AFC1-BDFF4BAC58C3}{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:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_des|text=|trigger=button}{sub-section}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_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:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_ret|text=|trigger=button}{sub-section}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_see|text=|trigger=button}{sub-section}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_see|text=|trigger=button}{sub-section}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_sam|text=|trigger=button}{sub-section}{sub-section:50B57025-60C4-477A-AFC1-BDFF4BAC58C3_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=F999C4F3-27C4-4FEB-97ED-B1F2F6833185}{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:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_des|text=|trigger=button}{sub-section}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_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:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_ret|text=|trigger=button}{sub-section}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_see|text=|trigger=button}{sub-section}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_see|text=|trigger=button}{sub-section}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_sam|text=|trigger=button}{sub-section}{sub-section:F999C4F3-27C4-4FEB-97ED-B1F2F6833185_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=DEA2988C-14B8-42D8-91D2-7B1DE1702598}{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:DEA2988C-14B8-42D8-91D2-7B1DE1702598_des|text=|trigger=button}{sub-section}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_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:DEA2988C-14B8-42D8-91D2-7B1DE1702598_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_ret|text=|trigger=button}{sub-section}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_see|text=|trigger=button}{sub-section}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_see|text=|trigger=button}{sub-section}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_sam|text=|trigger=button}{sub-section}{sub-section:DEA2988C-14B8-42D8-91D2-7B1DE1702598_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=2739C0E7-7203-4B88-83C5-BBE1A24224D2}{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:2739C0E7-7203-4B88-83C5-BBE1A24224D2_des|text=|trigger=button}{sub-section}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_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:2739C0E7-7203-4B88-83C5-BBE1A24224D2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_ret|text=|trigger=button}{sub-section}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_see|text=|trigger=button}{sub-section}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_see|text=|trigger=button}{sub-section}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_sam|text=|trigger=button}{sub-section}{sub-section:2739C0E7-7203-4B88-83C5-BBE1A24224D2_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=3FC7A3AA-2BCB-4227-88FD-C18078071DC8}{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:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_des|text=|trigger=button}{sub-section}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_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:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_ret|text=|trigger=button}{sub-section}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_see|text=|trigger=button}{sub-section}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_see|text=|trigger=button}{sub-section}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_sam|text=|trigger=button}{sub-section}{sub-section:3FC7A3AA-2BCB-4227-88FD-C18078071DC8_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=50E797E8-353F-43FB-80F1-C76E04A7201B}{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:50E797E8-353F-43FB-80F1-C76E04A7201B_des|text=|trigger=button}{sub-section}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_ret|text=|trigger=button}{sub-section}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_see|text=|trigger=button}{sub-section}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_see|text=|trigger=button}{sub-section}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_sam|text=|trigger=button}{sub-section}{sub-section:50E797E8-353F-43FB-80F1-C76E04A7201B_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=B528FCB0-81AB-4896-B0CD-BC936E72C5FA}{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:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_des|text=|trigger=button}{sub-section}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_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:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_ret|text=|trigger=button}{sub-section}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_see|text=|trigger=button}{sub-section}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_see|text=|trigger=button}{sub-section}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_sam|text=|trigger=button}{sub-section}{sub-section:B528FCB0-81AB-4896-B0CD-BC936E72C5FA_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=1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C}{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:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_des|text=|trigger=button}{sub-section}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_ret|text=|trigger=button}{sub-section}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_see|text=|trigger=button}{sub-section}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_see|text=|trigger=button}{sub-section}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_sam|text=|trigger=button}{sub-section}{sub-section:1BEBFCFF-A707-49E3-8EC1-B72E3F5DD76C_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} |