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=700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965}{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:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_des|text=|trigger=button}{sub-section}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_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:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_ret|text=|trigger=button}{sub-section}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_see|text=|trigger=button}{sub-section}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_see|text=|trigger=button}{sub-section}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_sam|text=|trigger=button}{sub-section}{sub-section:700897BC3F643655-E44E84A2-46E543C2-A652AAFC-B53869F02957B4BD61669965_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=0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313}{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:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_des|text=|trigger=button}{sub-section}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_des|trigger=none|class=sIndent}Delete a named http client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_prs|trigger=none}http_clientname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_ret|text=|trigger=button}{sub-section}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_see|text=|trigger=button}{sub-section}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_see|text=|trigger=button}{sub-section}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_sam|text=|trigger=button}{sub-section}{sub-section:0533DC3112CE7CB7-30D129FF-454945F6-ACDB9EB7-71A54F5F06CECA828453D313_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=6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24}{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:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_des|text=|trigger=button}{sub-section}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_des|trigger=none|class=sIndent}Get cookie object from the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_prs|trigger=none}clientName
cookieName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_ret|text=|trigger=button}{sub-section}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_see|text=|trigger=button}{sub-section}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_see|text=|trigger=button}{sub-section}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_sam|text=|trigger=button}{sub-section}{sub-section:6F217F00395E17B5-D3382C9F-41474E66-991DA5DA-673BF1046DB33403A94B4F24_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=D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72}{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:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_des|text=|trigger=button}{sub-section}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_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:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_prs|trigger=none}clientName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_ret|text=|trigger=button}{sub-section}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_see|text=|trigger=button}{sub-section}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_see|text=|trigger=button}{sub-section}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_sam|text=|trigger=button}{sub-section}{sub-section:D11A64D549EC66AB-FFD3D5B1-4C30453C-B8B6982B-4D7AB3A887DC6663431F1E72_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=DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D}{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:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_des|text=|trigger=button}{sub-section}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_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:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_ret|text=|trigger=button}{sub-section}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_see|text=|trigger=button}{sub-section}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_see|text=|trigger=button}{sub-section}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_sam|text=|trigger=button}{sub-section}{sub-section:DA30AC692935E7A7-2FD880C4-424B49B1-80CDAFDA-949677057173994215A8DE4D_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=3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953}{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:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_des|text=|trigger=button}{sub-section}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_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:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_ret|text=|trigger=button}{sub-section}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_see|text=|trigger=button}{sub-section}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_see|text=|trigger=button}{sub-section}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_sam|text=|trigger=button}{sub-section}{sub-section:3D798D9E7EEF4A47-432E03F6-41004A1D-B0C8B952-C520948EF6E2FB448689B953_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=F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540}{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:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_des|text=|trigger=button}{sub-section}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_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:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_prs|trigger=none}url
\[http_clientname\]
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_ret|text=|trigger=button}{sub-section}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_see|text=|trigger=button}{sub-section}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_see|text=|trigger=button}{sub-section}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_sam|text=|trigger=button}{sub-section}{sub-section:F35764D7C910C7E8-CAC9E6EF-430144A7-9D6D9405-2F393E5038EB7C6AA1F69540_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=62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C}{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:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_des|text=|trigger=button}{sub-section}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_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:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_prs|trigger=none}url
\[http_clientname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_ret|text=|trigger=button}{sub-section}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_ret|trigger=none|class=sIndent}[Poster]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_see|text=|trigger=button}{sub-section}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_see|text=|trigger=button}{sub-section}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_sam|text=|trigger=button}{sub-section}{sub-section:62D20D9CB9ACE3FA-AEC4A8FE-44D84473-9A809C8F-EDE11243FDAAD175433D417C_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=CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8}{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:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_des|text=|trigger=button}{sub-section}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_des|trigger=none|class=sIndent}Put a file at the specified URL.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_prs|trigger=none}clientName
url
fileName
filePath
\[username\]
\[password\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_ret|text=|trigger=button}{sub-section}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_see|text=|trigger=button}{sub-section}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_see|text=|trigger=button}{sub-section}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_sam|text=|trigger=button}{sub-section}{sub-section:CC8D0631C0B3A25B-901F2CE6-4BAC40C1-9C308761-F8D2C8024AAF5C637F6748B8_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=CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E}{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:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_des|text=|trigger=button}{sub-section}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_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:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_prs|trigger=none}username
password
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_ret|text=|trigger=button}{sub-section}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_see|text=|trigger=button}{sub-section}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_see|text=|trigger=button}{sub-section}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_sam|text=|trigger=button}{sub-section}{sub-section:CCED0EBE16E93621-938A9A88-45604AC2-B4EC8A83-B4996FE5ED58C7FF5F36227E_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=F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F}{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:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_des|text=|trigger=button}{sub-section}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_des|trigger=none|class=sIndent}Add cookie to the specified client.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_prs|trigger=none}clientName
cookieName
cookieValue
\[domain\]
\[path\]
\[maxAge\]
\[secure\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_ret|text=|trigger=button}{sub-section}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_see|text=|trigger=button}{sub-section}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_see|text=|trigger=button}{sub-section}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_sam|text=|trigger=button}{sub-section}{sub-section:F667F7D2E8205614-1B4751E6-4EA54973-9D229309-B73BADE2A096FAE429E3AE9F_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 6

New Version 7

Key
