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=243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA}{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:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_des|text=|trigger=button}{sub-section}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_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:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_ret|text=|trigger=button}{sub-section}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_see|text=|trigger=button}{sub-section}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_see|text=|trigger=button}{sub-section}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_sam|text=|trigger=button}{sub-section}{sub-section:243970984C6E481C-7AB40FDF-4CD94E72-B876B661-F8D93EA38A8CBF9732B12FAA_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=6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F}{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:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_des|text=|trigger=button}{sub-section}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_ret|text=|trigger=button}{sub-section}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_see|text=|trigger=button}{sub-section}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_see|text=|trigger=button}{sub-section}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_sam|text=|trigger=button}{sub-section}{sub-section:6F254F19B4F1086E-277F5BC2-484B44DB-B04888EE-3CEA32489CF616133A153B4F_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=C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099}{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:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_des|text=|trigger=button}{sub-section}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_ret|text=|trigger=button}{sub-section}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_see|text=|trigger=button}{sub-section}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_see|text=|trigger=button}{sub-section}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_sam|text=|trigger=button}{sub-section}{sub-section:C232DAFBD17826CB-CAA55A69-45154382-BE1FB6B2-79D24DF68E62AA48FCB13099_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=B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3}{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:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_des|text=|trigger=button}{sub-section}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_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:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_ret|text=|trigger=button}{sub-section}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_see|text=|trigger=button}{sub-section}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_see|text=|trigger=button}{sub-section}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_sam|text=|trigger=button}{sub-section}{sub-section:B23B7C94D94A019C-2FEFCAD2-451845B1-B90BB205-0BFD473742EA24B3F0C837A3_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=161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387}{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:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_des|text=|trigger=button}{sub-section}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_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:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_ret|text=|trigger=button}{sub-section}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_see|text=|trigger=button}{sub-section}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_see|text=|trigger=button}{sub-section}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_sam|text=|trigger=button}{sub-section}{sub-section:161D6B9AC0090DE6-12D2E334-4403453A-AA10839E-92D14A84368BD6BBEA58D387_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=C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094}{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:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_des|text=|trigger=button}{sub-section}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_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:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_ret|text=|trigger=button}{sub-section}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_see|text=|trigger=button}{sub-section}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_see|text=|trigger=button}{sub-section}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_sam|text=|trigger=button}{sub-section}{sub-section:C361F2A2C563739C-4F0A74E3-4A6E43C6-852F9E8E-FF28495B655F2BBFBB74E094_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=C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11}{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:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_des|text=|trigger=button}{sub-section}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_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:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_ret|text=|trigger=button}{sub-section}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_see|text=|trigger=button}{sub-section}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_see|text=|trigger=button}{sub-section}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_sam|text=|trigger=button}{sub-section}{sub-section:C2DB29A8B997C682-41785582-442D4574-A202AC88-3D79B799314AB55E84BE1F11_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=5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43}{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:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_des|text=|trigger=button}{sub-section}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_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:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_ret|text=|trigger=button}{sub-section}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_see|text=|trigger=button}{sub-section}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_see|text=|trigger=button}{sub-section}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_sam|text=|trigger=button}{sub-section}{sub-section:5BF231FDEE7C0555-780C146F-4F7C40E1-BC5B9998-1B6AD2AA30A2760AB1BD1F43_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=6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A}{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:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_des|text=|trigger=button}{sub-section}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_ret|text=|trigger=button}{sub-section}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_see|text=|trigger=button}{sub-section}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_see|text=|trigger=button}{sub-section}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_sam|text=|trigger=button}{sub-section}{sub-section:6DDB29AD03BBD780-04E89696-49B246B9-B337A3EE-AA916899AB73E8100B8F809A_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=9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78}{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:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_des|text=|trigger=button}{sub-section}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_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:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_ret|text=|trigger=button}{sub-section}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_see|text=|trigger=button}{sub-section}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_see|text=|trigger=button}{sub-section}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_sam|text=|trigger=button}{sub-section}{sub-section:9CC85295CE10026D-A21FE8D2-4EF94CF9-830EB31B-B3B3C73A89C66F3C7331FB78_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=02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE}{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:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_des|text=|trigger=button}{sub-section}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_ret|text=|trigger=button}{sub-section}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_see|text=|trigger=button}{sub-section}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_see|text=|trigger=button}{sub-section}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_sam|text=|trigger=button}{sub-section}{sub-section:02BE68DEE9138ACB-C0E1B536-4C22483F-9220BCAC-3EDC24899EB12E3E2B9A88DE_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 3

New Version 4

Key
