{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:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[DeleteRequest]{td}{td}[#createDeleteRequest]\(url)
Creates a new delete request (a request to delete a resource on server).{td}{tr}{tbody}{tbody}{tr}{td}[GetRequest]{td}{td}[#createGetRequest]\(url)
Creates a new get request (retrieves whatever information is stored on specified url).{td}{tr}{tbody}{tbody}{tr}{td}[HeadRequest]{td}{td}[#createHeadRequest]\(url)
Creates a new head request (similar to get request, must not contain body content).{td}{tr}{tbody}{tbody}{tr}{td}[OptionsRequest]{td}{td}[#createOptionsRequest]\(url)
Creates a new options request (a request for information about communication options).{td}{tr}{tbody}{tbody}{tr}{td}[PostRequest]{td}{td}[#createPostRequest]\(url)
Create a new post request ( Origin server should accept/process the submitted data.{td}{tr}{tbody}{tbody}{tr}{td}[PutRequest]{td}{td}[#createPutRequest]\(url)
Creates a new put request (similar to post request, contains information to be submitted).{td}{tr}{tbody}{tbody}{tr}{td}[TraceRequest]{td}{td}[#createTraceRequest]\(url)
Creates a new trace request (debug request, server will just echo back).{td}{tr}{tbody}{tbody}{tr}{td}[Cookie]{td}{td}[#getCookie]\(cookieName)
Get a cookie by name.{td}{tr}{tbody}{tbody}{tr}{td}[Cookie]\[]{td}{td}[#getCookies]\()
Get all cookies from this client.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setClientProxyCredentials]\(userName, password)
Set proxy credentials.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setCookie]\(cookieName, cookieValue)
Add cookie to the this client.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setCookie]\(cookieName, cookieValue, domain)
Add cookie to the this client.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setCookie]\(cookieName, cookieValue, domain, path)
Add cookie to the this client.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setCookie]\(cookieName, cookieValue, domain, path, maxAge)
Add cookie to the this client.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#setCookie]\(cookieName, cookieValue, domain, path, maxAge, secure)
Add cookie to the this client.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setTimeout]\(msTimeout)
Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=createDeleteRequest|class=node}{tr:id=name}{td}h6.createDeleteRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[DeleteRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createDeleteRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createDeleteRequest_des|text=|trigger=button}{sub-section}{sub-section:createDeleteRequest_des|trigger=none|class=sIndent}Creates a new delete request (a request to delete a resource on server).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createDeleteRequest_snc|text=|trigger=button}{sub-section}{sub-section:createDeleteRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createDeleteRequest_prs|text=|trigger=button}{sub-section}{sub-section:createDeleteRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createDeleteRequest_ret|text=|trigger=button}{sub-section}{sub-section:createDeleteRequest_ret|trigger=none|class=sIndent}[DeleteRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createDeleteRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createDeleteRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createDeleteRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createDeleteRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createDeleteRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createDeleteRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var request = client.createDeleteRequest('http://www.servoy.com/delete.me');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createGetRequest|class=node}{tr:id=name}{td}h6.createGetRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[GetRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createGetRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createGetRequest_des|text=|trigger=button}{sub-section}{sub-section:createGetRequest_des|trigger=none|class=sIndent}Creates a new get request (retrieves whatever information is stored on specified url).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createGetRequest_snc|text=|trigger=button}{sub-section}{sub-section:createGetRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createGetRequest_prs|text=|trigger=button}{sub-section}{sub-section:createGetRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createGetRequest_ret|text=|trigger=button}{sub-section}{sub-section:createGetRequest_ret|trigger=none|class=sIndent}[GetRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createGetRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createGetRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createGetRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createGetRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createGetRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createGetRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var request = client.createGetRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createHeadRequest|class=node}{tr:id=name}{td}h6.createHeadRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[HeadRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createHeadRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createHeadRequest_des|text=|trigger=button}{sub-section}{sub-section:createHeadRequest_des|trigger=none|class=sIndent}Creates a new head request (similar to get request, must not contain body content).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createHeadRequest_snc|text=|trigger=button}{sub-section}{sub-section:createHeadRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createHeadRequest_prs|text=|trigger=button}{sub-section}{sub-section:createHeadRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createHeadRequest_ret|text=|trigger=button}{sub-section}{sub-section:createHeadRequest_ret|trigger=none|class=sIndent}[HeadRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createHeadRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createHeadRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createHeadRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createHeadRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createHeadRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createHeadRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var request = client.createHeadRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok
var header = response.getResponseHeaders('last-modified');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createOptionsRequest|class=node}{tr:id=name}{td}h6.createOptionsRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[OptionsRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createOptionsRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createOptionsRequest_des|text=|trigger=button}{sub-section}{sub-section:createOptionsRequest_des|trigger=none|class=sIndent}Creates a new options request (a request for information about communication options).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createOptionsRequest_snc|text=|trigger=button}{sub-section}{sub-section:createOptionsRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createOptionsRequest_prs|text=|trigger=button}{sub-section}{sub-section:createOptionsRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createOptionsRequest_ret|text=|trigger=button}{sub-section}{sub-section:createOptionsRequest_ret|trigger=none|class=sIndent}[OptionsRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createOptionsRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createOptionsRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createOptionsRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createOptionsRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createOptionsRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createOptionsRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var request = client.createOptionsRequest('http://www.servoy.com');
var methods = request.getAllowedMethods(request.executeRequest());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createPostRequest|class=node}{tr:id=name}{td}h6.createPostRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[PostRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createPostRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createPostRequest_des|text=|trigger=button}{sub-section}{sub-section:createPostRequest_des|trigger=none|class=sIndent}Create a new post request ( Origin server should accept/process the submitted data.){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createPostRequest_snc|text=|trigger=button}{sub-section}{sub-section:createPostRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createPostRequest_prs|text=|trigger=button}{sub-section}{sub-section:createPostRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createPostRequest_ret|text=|trigger=button}{sub-section}{sub-section:createPostRequest_ret|trigger=none|class=sIndent}[PostRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createPostRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPostRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createPostRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPostRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createPostRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPostRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var poster = client.createPostRequest('https://twitter.com/statuses/update.json');
poster.addParameter('status',globals.textToPost);
poster.addParameter('source','Test Source');
poster.setCharset('UTF-8');
var httpCode = poster.executeRequest(globals.twitterUserName, globals.twitterPassword).getStatusCode(); // httpCode 200 is ok
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createPutRequest|class=node}{tr:id=name}{td}h6.createPutRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[PutRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createPutRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createPutRequest_des|text=|trigger=button}{sub-section}{sub-section:createPutRequest_des|trigger=none|class=sIndent}Creates a new put request (similar to post request, contains information to be submitted).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createPutRequest_snc|text=|trigger=button}{sub-section}{sub-section:createPutRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createPutRequest_prs|text=|trigger=button}{sub-section}{sub-section:createPutRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createPutRequest_ret|text=|trigger=button}{sub-section}{sub-section:createPutRequest_ret|trigger=none|class=sIndent}[PutRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createPutRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPutRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createPutRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPutRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createPutRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createPutRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var request = client.createPutRequest('http://jakarta.apache.org');
request.setFile('UploadMe.gif');
var httpCode = putRequest.executeRequest().getStatusCode() // httpCode 200 is ok
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createTraceRequest|class=node}{tr:id=name}{td}h6.createTraceRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[TraceRequest]{span}{span:id=iets|style=float: left; font-weight: bold;}createTraceRequest{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:createTraceRequest_des|text=|trigger=button}{sub-section}{sub-section:createTraceRequest_des|trigger=none|class=sIndent}Creates a new trace request (debug request, server will just echo back).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createTraceRequest_snc|text=|trigger=button}{sub-section}{sub-section:createTraceRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createTraceRequest_prs|text=|trigger=button}{sub-section}{sub-section:createTraceRequest_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createTraceRequest_ret|text=|trigger=button}{sub-section}{sub-section:createTraceRequest_ret|trigger=none|class=sIndent}[TraceRequest]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createTraceRequest_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTraceRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createTraceRequest_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTraceRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createTraceRequest_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTraceRequest_sam|trigger=none}{code:language=javascript}
var client = plugins.http.createNewHttpClient();
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCookie|class=node}{tr:id=name}{td}h6.getCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Cookie]{span}{span:id=iets|style=float: left; font-weight: bold;}getCookie{span}{span:id=iets|style=float: left;}\(cookieName){span}{td}{tr}{tr:id=des}{td}{sub-section:getCookie_des|text=|trigger=button}{sub-section}{sub-section:getCookie_des|trigger=none|class=sIndent}Get a cookie by name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCookie_snc|text=|trigger=button}{sub-section}{sub-section:getCookie_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getCookie_prs|text=|trigger=button}{sub-section}{sub-section:getCookie_prs|trigger=none|class=sIndent}\{[String]} cookieName
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getCookie_ret|text=|trigger=button}{sub-section}{sub-section:getCookie_ret|trigger=none|class=sIndent}[Cookie]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCookie_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookie_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCookie_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookie_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCookie_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookie_sam|trigger=none}{code:language=javascript}
var cookie = client.getCookie('JSESSIONID');
if (cookie != null)
{
// do something
}
else
client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCookies|class=node}{tr:id=name}{td}h6.getCookies{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Cookie]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getCookies{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getCookies_des|text=|trigger=button}{sub-section}{sub-section:getCookies_des|trigger=none|class=sIndent}Get all cookies from this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCookies_snc|text=|trigger=button}{sub-section}{sub-section:getCookies_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCookies_prs|text=|trigger=button}{sub-section}{sub-section:getCookies_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCookies_ret|text=|trigger=button}{sub-section}{sub-section:getCookies_ret|trigger=none|class=sIndent}[Cookie]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCookies_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookies_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCookies_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookies_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCookies_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getCookies_sam|trigger=none}{code:language=javascript}
var cookies = client.getHttpClientCookies()
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setClientProxyCredentials|class=node}{tr:id=name}{td}h6.setClientProxyCredentials{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setClientProxyCredentials{span}{span:id=iets|style=float: left;}\(userName, password){span}{td}{tr}{tr:id=des}{td}{sub-section:setClientProxyCredentials_des|text=|trigger=button}{sub-section}{sub-section:setClientProxyCredentials_des|trigger=none|class=sIndent}Set proxy credentials.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setClientProxyCredentials_snc|text=|trigger=button}{sub-section}{sub-section:setClientProxyCredentials_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setClientProxyCredentials_prs|text=|trigger=button}{sub-section}{sub-section:setClientProxyCredentials_prs|trigger=none|class=sIndent}\{[String]} userName
\{[String]} password
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setClientProxyCredentials_ret|text=|trigger=button}{sub-section}{sub-section:setClientProxyCredentials_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setClientProxyCredentials_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setClientProxyCredentials_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setClientProxyCredentials_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setClientProxyCredentials_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setClientProxyCredentials_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setClientProxyCredentials_sam|trigger=none}{code:language=javascript}
client.setClientProxyCredentials('my_proxy_username','my_proxy_password');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCookie-String_String|class=node}{tr:id=name}{td}h6.setCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setCookie{span}{span:id=iets|style=float: left;}\(cookieName, cookieValue){span}{td}{tr}{tr:id=des}{td}{sub-section:setCookie-String_String_des|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_des|trigger=none|class=sIndent}Add cookie to the this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCookie-String_String_snc|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCookie-String_String_prs|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_prs|trigger=none|class=sIndent}\{[String]} cookieName -- the name of the cookie
\{[String]} cookieValue -- the value of the cookie
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCookie-String_String_ret|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCookie-String_String_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCookie-String_String_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCookie-String_String_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_sam|trigger=none}{code:language=javascript}
var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCookie-String_String_String|class=node}{tr:id=name}{td}h6.setCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setCookie{span}{span:id=iets|style=float: left;}\(cookieName, cookieValue, domain){span}{td}{tr}{tr:id=des}{td}{sub-section:setCookie-String_String_String_des|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_des|trigger=none|class=sIndent}Add cookie to the this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCookie-String_String_String_snc|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCookie-String_String_String_prs|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_prs|trigger=none|class=sIndent}\{[String]} cookieName -- the name of the cookie
\{[String]} cookieValue -- the value of the cookie
\{[String]} domain -- the domain
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCookie-String_String_String_ret|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCookie-String_String_String_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCookie-String_String_String_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCookie-String_String_String_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_sam|trigger=none}{code:language=javascript}
var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCookie-String_String_String_String|class=node}{tr:id=name}{td}h6.setCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setCookie{span}{span:id=iets|style=float: left;}\(cookieName, cookieValue, domain, path){span}{td}{tr}{tr:id=des}{td}{sub-section:setCookie-String_String_String_String_des|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_des|trigger=none|class=sIndent}Add cookie to the this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCookie-String_String_String_String_snc|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCookie-String_String_String_String_prs|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_prs|trigger=none|class=sIndent}\{[String]} cookieName -- the name of the cookie
\{[String]} cookieValue -- the value of the cookie
\{[String]} domain -- the domain
\{[String]} path -- the path
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCookie-String_String_String_String_ret|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCookie-String_String_String_String_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCookie-String_String_String_String_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCookie-String_String_String_String_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_sam|trigger=none}{code:language=javascript}
var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCookie-String_String_String_String_Number|class=node}{tr:id=name}{td}h6.setCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setCookie{span}{span:id=iets|style=float: left;}\(cookieName, cookieValue, domain, path, maxAge){span}{td}{tr}{tr:id=des}{td}{sub-section:setCookie-String_String_String_String_Number_des|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_des|trigger=none|class=sIndent}Add cookie to the this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCookie-String_String_String_String_Number_snc|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCookie-String_String_String_String_Number_prs|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_prs|trigger=none|class=sIndent}\{[String]} cookieName -- the name of the cookie
\{[String]} cookieValue -- the value of the cookie
\{[String]} domain -- the domain
\{[String]} path -- the path
\{[Number]} maxAge -- maximum age of cookie
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCookie-String_String_String_String_Number_ret|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCookie-String_String_String_String_Number_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCookie-String_String_String_String_Number_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCookie-String_String_String_String_Number_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_sam|trigger=none}{code:language=javascript}
var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCookie-String_String_String_String_Number_Boolean|class=node}{tr:id=name}{td}h6.setCookie{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setCookie{span}{span:id=iets|style=float: left;}\(cookieName, cookieValue, domain, path, maxAge, secure){span}{td}{tr}{tr:id=des}{td}{sub-section:setCookie-String_String_String_String_Number_Boolean_des|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_Boolean_des|trigger=none|class=sIndent}Add cookie to the this client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_snc|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_prs|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_Boolean_prs|trigger=none|class=sIndent}\{[String]} cookieName -- the name of the cookie
\{[String]} cookieValue -- the value of the cookie
\{[String]} domain -- the domain
\{[String]} path -- the path
\{[Number]} maxAge -- maximum age of cookie
\{[Boolean]} secure -- true if it is a secure cookie, false otherwise
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_ret|text=|trigger=button}{sub-section}{sub-section:setCookie-String_String_String_String_Number_Boolean_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCookie-String_String_String_String_Number_Boolean_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setCookie-String_String_String_String_Number_Boolean_sam|trigger=none}{code:language=javascript}
var cookieSet = client.setCookie('JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setTimeout|class=node}{tr:id=name}{td}h6.setTimeout{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setTimeout{span}{span:id=iets|style=float: left;}\(msTimeout){span}{td}{tr}{tr:id=des}{td}{sub-section:setTimeout_des|text=|trigger=button}{sub-section}{sub-section:setTimeout_des|trigger=none|class=sIndent}Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setTimeout_snc|text=|trigger=button}{sub-section}{sub-section:setTimeout_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setTimeout_prs|text=|trigger=button}{sub-section}{sub-section:setTimeout_prs|trigger=none|class=sIndent}msTimeout
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setTimeout_ret|text=|trigger=button}{sub-section}{sub-section:setTimeout_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setTimeout_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setTimeout_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setTimeout_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setTimeout_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setTimeout_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setTimeout_sam|trigger=none}{code:language=javascript}
client.setTimeout(1000)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientservoy sSummary12%30%58%height: 30px;3Methods Summaryvoidreleases all resources that this client has, should be called after usage.Creates a new delete request (a request to delete a resource on server).Creates a new get request (retrieves whatever information is stored on specified url).Creates a new head request (similar to get request, must not contain body content).Creates a new options request (a request for information about communication options).Creates a new patch request (used for granular updates).Create a new post request ( Origin server should accept/process the submitted data.Creates a new put request (similar to post request, contains information to be submitted).Creates a new trace request (debug request, server will just echo back).Get a cookie by name.Get all cookies from this client.voidSet proxy credentials.voidSet proxy server.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.voidSets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).functionservoy sDetail2100%height:30px2Methods Detailsclosename
close()
dessIndent
releases all resources that this client has, should be called after usage.
Creates a new delete request (a request to delete a resource on server).
prs
Parameters
sIndenturl ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateGetRequestname
createGetRequest(url)
dessIndent
Creates a new get request (retrieves whatever information is stored on specified url).
If this url is a https ssl encrypted url which certificates are not in the java certificate store.
(Like a self signed certificate or a none existing root certificate)
Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time.
For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server.
See http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file
Create a new post request ( Origin server should accept/process the submitted data.)
If this url is a https ssl encrypted url which certificates are not in the java certificate store.
(Like a self signed certificate or a none existing root certificate)
Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time.
For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server.
See http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file
prs
Parameters
sIndenturl ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreatePutRequestname
createPutRequest(url)
dessIndent
Creates a new put request (similar to post request, contains information to be submitted).
sIndentcookieNamethe name of the cookiecookieValuethe value of the cookiedomainthe domainpaththe pathmaxAgemaximum age of cookiesecuretrue if it is a secure cookie, false otherwiseret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetTimeoutname
setTimeout(msTimeout)
dessIndent
Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).