Child pages
  • TraceRequest

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

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.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
addHeader(headerName, value)
Add a header to the request.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous using windows authentication.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.
Table Row (tr)
Table Cell (td)
Response
Table Cell (td)
executeRequest()
Execute the request method.
Table Row (tr)
Table Cell (td)
Response
Table Cell (td)
executeRequest(userName, password)
Execute the request method.
Table Row (tr)
Table Cell (td)
Response
Table Cell (td)
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
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
Span
(headerName, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a header to the request.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} headerName
{String} value
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
method.addHeader('Content-type','text/xml; charset=ISO-8859-1')
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
Span
(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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. 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
{String} username - the user name
{String} password - the password
{String} workstation - The 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 - callbackMethod to be called if request errors out
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
Span
(username, password, 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
{String} username - the user name
{String} password - the password
{Function} successCallbackMethod - callbackMethod to be called after response is received
{Function} errorCallbackMethod - callbackMethod to be called if request errors out
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 after response is received
{Function} errorCallbackMethod - callbackMethod to be called if request errors out
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
Span
(userName, password, workstation, domain)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a request method using windows authentication.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} userName - the user name
{String} password - the password
{String} workstation - The workstation the authentication request is originating from.
{String} domain - The domain to authenticate within.
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('username','password','mycomputername','domain');
Table Row (tr)
classlastDetailRow
Table Cell (td)