Child pages
  • TraceRequest

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
Divcache
styleindexdisplay:none

...

iddescription

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#addHeader(headerName, value)
Add a header to the request.

...

Table Cell (td)
void

...

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryAdd a header to the request.voidExecute the request method asynchronous.voidExecute the request method asynchronous using windows authentication.voidExecute the request method asynchronous.voidExecute the request method asynchronous using windows authentication.

...

void

...

...

Execute the request method asynchronous.

...

void

...

Execute the request method asynchronous

...

Table Cell (td)
Response

...

using windows authentication.Execute the request method.

...

Table Cell (td)
Response

...

Execute the request method.

...

Table Cell (td)
Response

...

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idaddHeader-String_String
Table Row (tr)
idname
Table Cell (td)
addHeader
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
addHeader
SpanExecute a request method using windows authentication.

...

functionservoy sDetail2100%height:30px2Methods DetailsaddHeadername

addHeader(headerName, value)

dessIndent
Add a header to the request.
tr
prs

Parameters


classtd

sIndent

headerName ;value ;ret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
voidWhatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent)

id
Table Row (tr)
Table Cell (td)
Div
classid
Table Cell (td)
Div
Table Row (tr)
idret
{String} headerName
{String} value
Boolean
Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
Table Body (tbody)
idexecuteAsyncRequest-String_String_String_String_Function_Function
Table Row (tr)
idname
Table Cell (td)
executeAsyncRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeAsyncRequest
SpanSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

method.addHeader('Content-type','text/xml; charset=ISO-8859-1')
sIdentjavascriptlastDetailRowexecuteAsyncRequestname

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)

dessIndent
Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordworkstationThe workstation the authentication request is originating from.domainThe domain to authenticate within.successCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

Table Row (tr)idclass

des Table Cell (td) DivsIndent
Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter
. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} username – the user name
{String} password – the password
{String} workstation –
 followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordworkstationThe workstation the authentication request is originating from.

{String} domain The domain to authenticate within.
{Function} successCallbackMethod callbackMethod to be called after response is received
{Function} errorCallbackMethod
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback)
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idexecuteAsyncRequest-String_String_Function_Function
Table Row (tr)
idname
Table Cell (td)
executeAsyncRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeAsyncRequest
SpancallbackMethod to be called if request errors outcallbackExtraArgsextra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

dessIndent
Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

Table Row (tr)id Divclass

des Table Cell (td)sIndent
Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter
. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} username – the user name
{String} password – the password
{Function} successCallbackMethod –
 followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordsuccessCallbackMethodcallbackMethod to be called after response is received

{Function} errorCallbackMethod
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idexecuteAsyncRequest-Function_Function
Table Row (tr)
idname
Table Cell (td)
executeAsyncRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeAsyncRequest
Span
(successCallbackMethod, errorCallbackMethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{Function} successCallbackMethod – callbackMethod to be called if request errors outcallbackExtraArgsextra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

dessIndent
Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
prs

Parameters

sIndentsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

dessIndent
Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentsuccessCallbackMethodcallbackMethod to be called after response is received

{Function} errorCallbackMethod
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idexecuteRequest
Table Row (tr)
idname
Table Cell (td)
executeRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Response
Span
stylefont-weight: bold;
executeRequest
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute the request method.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Response
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var response = method.executeRequest()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idexecuteRequest-String_String
Table Row (tr)
idname
Table Cell (td)
executeRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Response
Span
stylefont-weight: bold;
executeRequest
Span
(userName, password)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute the request method.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} userName – the user name
{String} password – the password
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Response
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var response = method.executeRequest()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idexecuteRequest-String_String_String_String
Table Row (tr)
idname
Table Cell (td)
executeRequest
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Response
Span
stylefont-weight: bold;
executeRequest
SpancallbackMethod to be called if request errors outcallbackExtraArgsextra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest()

dessIndent
Execute the request method.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest(userName, password)

dessIndent
Execute the request method.
prs

Parameters

sIndentuserNamethe user namepasswordthe password
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest(userName, password, workstation, domain)

Table Row (tr)idclass

des Table Cell (td) DividsIndent
Execute a request method using windows authentication.
Table Row (tr)tdprs

Parameters


Divclass

sIndent{String} userName the user name
{String} password the password
{String} workstation The workstation the authentication request is originating from.
{String} domain Table Row (tr)idThe domain to authenticate within.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Response Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
tdSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

var response = method.executeRequest('username','password','mycomputername','domain');
sIdentjavascriptlastDetailRowusePreemptiveAuthenticationname

usePreemptiveAuthentication(b)

dessIndent
Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to
the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big,
as the authentication request to the client was not yet sent)
prs

Parameters

sIndentb ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow