RestClient NewSecure( String hostName,
                      Integer port,
                      String initialURI,
                      [Integer timeout],
                      [String certPath],
                      [String certFile],
                      [String keyFile] )

Returns a new RestClient object, one of the certpath, certfile or keyfile parameters is required. Certificate validation disabled.

Parameters

hostName

IP address or domain name of HTTP host.

port

HTTP connection port, required

initialURI

The base URI

timeout

Request timeout, default 200, min value 15

certPath

The path to default certs, if no cert file or keyfile is supplied, this directory will be searched for the apppropriate certificate, on linux usually /etc/ssl/certs, on windows, a default directory must be populated

certFile

The path/name of a user supplied certs file, this file must contain a complete certificate chain. use if there is no default cert store or certificate is self-signed

keyFile

The path/name of a user supplied private key file, used for self-generated keys

Returns:

A new RestClient object or undefined if there was an error constructing the object.

Instance Methods

AddAuthentication

Integer AddAuthentication( String userName,
String password )

Adds authentication to the request and sends it if the server returns an authentication required http response.

Parameters

userName

The username for authentication

password

The password or certificate for authentication

Returns:

0 if successful or undefined if an error

Delete

Assoc Delete( Assoc urlParams,
Assoc headerFields )

Constructs the header using the initialURI and supplied list of parm=value pairs and sends a delete.

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

Returns:

Request return or error with message

Get

Assoc Get( Assoc urlParams,
Assoc headerFields )

Constructs the header using the initialURI and supplied Assoc of parm=value pairs and sends a get.

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

Returns:

Request return or error with message

GetURI

String GetURI()

Returns the current URI.

Returns:

The URI or undefined

Patch

Assoc Patch( Assoc urlParams,
             String body,
             Integer bodyLen,
             Assoc headerFields )

Constructs the header using the initialURI and supplied Assoc of parm=value pairs and sends a patch.

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

body

String containing patch content, may contain binary data

bodyLen

Length of the body content

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

Returns:

Request return or error with message

Post

Assoc Post( Assoc urlParams,
            String body,
            Integer bodyLen,
            [Assoc headerFields],
            [Assoc postParams] )

Constructs the header using the initialURI and supplied Assoc of parm=value pairs and sends a post.

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

body

String containing post content, may contain binary data

bodyLen

Length of the body content

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

postParams

Assoc of key value pairs to send as HTTP POST parameters. NOTE: Should NOT be URL escaped. This can only be specified if the body is empty and length is 0.

Returns:

Request return or error with message

PostFile

Assoc PostFile( Assoc urlParams,
                String filePath,
                String fileName,
                String postFileParam,
                String contentType,
                [Assoc headerFields],
                [Assoc postParams] )

Sends the given file as a HTTP multipart message

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

filePath

The fully qualified path to the local file that is to be uploaded

fileName

The file name to be used for the HTML form element (may be different than the local filename)

postFileParam

The HTML form element name associated with the file

contentType

The content or MIME type of the file

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

postParams

Assoc of key value pairs to send as HTTP multipart POST parameters. NOTE: Should NOT be URL escaped.

Returns:

Request return or error with message

Put

Assoc Put( Assoc urlParams,
           String body,
           Integer bodyLen,
           Assoc headerFields )

Constructs the header using the initialURI and supplied Assoc of parm=value pairs and sends a put.

Parameters

urlParams

Assoc of key value pairs to add to the URL query string (will URL encode if required)

body

String containing put content, may contain binary data

bodyLen

Length of the body content

headerFields

Assoc of key value pairs to add additional fields to the HTTP header

Returns:

Request return or error with message

SetContentType

Integer SetContentType( String contentType )

Set the Content-Type HTTP header for all requests sent by this client.

Parameters

contentType

The value of the header

Returns:

0 or undefined

SetDestFile

Integer SetDestFile( String filename )

Allows larger content from the server to be written to a file instead of returning it in the Assoc.

Parameters

filename

String containing the file path/name

Returns:

0 or undefined

SetURI

Integer SetURI( String newURI )

Sets the URI to a new value.

Parameters

newURI

The URI

Returns:

0 or undefined