May 15, 2024 03:29 Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
Methods Summary
Boolean
addHeader(headerName, value)
Add a header to the request.
void
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous using windows authentication.
void
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Execute the request method asynchronous using windows authentication.
void
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.
void
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Executes the request method asynchronous.
void
executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.
void
executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Executes the request method asynchronous.
Response
executeRequest()
Execute the request method.
Response
executeRequest(userName, password)
Execute the request method.
Response
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.
Array
getAllowedMethods(res)
Returns the supported HTTP Request operations as a String Array
void
usePreemptiveAuthentication(b)
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)
Methods Details
addHeader(headerName, value)
Add a header to the request.
String
headerName
;
String
value
;
method.addHeader('Content-type','text/xml; charset=ISO-8859-1')
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
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.
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
method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback)
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
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.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
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
Array
callbackExtraArgs
extra 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)
method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback, [callIDInt])
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
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.
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
method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Executes the request method asynchronous.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
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
Array
callbackExtraArgs
extra 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)
method.executeAsyncRequest(globals.successCallback,globals.errorCallback, [callIDInt])
executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
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.
Function
successCallbackMethod
callbackMethod to be called after response is received
Function
errorCallbackMethod
callbackMethod to be called if request errors out
method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
Executes the request method asynchronous.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Function
successCallbackMethod
callbackMethod to be called after response is received
Function
errorCallbackMethod
callbackMethod to be called if request errors out
Array
callbackExtraArgs
extra 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)
method.executeAsyncRequest(globals.successCallback,globals.errorCallback, [callIDInt])
executeRequest()
Execute the request method.
var response = method.executeRequest()
To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
or getMediaData:
response.close()
executeRequest(userName, password)
Execute the request method.
String
userName
the user name
String
password
the password
var response = method.executeRequest()
To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
or getMediaData:
response.close()
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.
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.
var response = method.executeRequest('username','password','mycomputername','domain');
getAllowedMethods(res)
Returns the supported HTTP Request operations as a String Array
Response
res
The response request to get the allowed methods from.
var supportedOperations = request.getAllowedMethods()
application.output(supportedOperations.join(','));
usePreemptiveAuthentication(b)
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)
Boolean
b
;