Class HTTPClient

Object
- dw.net.HTTPClient

The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE. If a secure connection via HTTPS is established the used server certificate or the signing CAs certificate needs to be imported into the customer key store via Business Manager. Note: when this class is used with sensitive data, be careful in persisting sensitive information. Key selection for mutual TLS:

Check if there is an explicit identity requested setIdentity(KeyRef)
Else, Check if there is a mapping for hostname in the keystore
Deprecated: Select an arbitrary private key from the keystore

var httpClient : HTTPClient = new HTTPClient(); var message : String; httpClient.open('GET', 'http://www.myinstance.com/feed.xml'); httpClient.setTimeout(3000); httpClient.send(); if (httpClient.statusCode == 200) { message = httpClient.text; } else { // error handling message="An error occurred with status code "+httpClient.statusCode; }

Constants

DEFAULT_GET_FILE_SIZE : Number=5242880

The default size for sendAndReceiveToFile() returning a File is 5MB deprecated in favor of MAX_GET_FILE_SIZE

Deprecated:

Use MAX_GET_FILE_SIZE instead.

MAX_GET_FILE_SIZE : Number=209715200

The maximum permitted size (in bytes) of an HTTP response when calling operations which write the response to file. (200MB)

MAX_GET_MEM_SIZE : Number=10485760

The maximum permitted size (in bytes) of an HTTP response when calling operations which store the response in memory. (10MB)

Properties

allowRedirect : boolean

Determines whether redirect handling is enabled.

allResponseHeaders : HashMap Read Only

All response headers as a map containing the name and value of the response header.

Deprecated:

Use getResponseHeaders() instead.

bytes : Bytes Read Only

The bytes in the message body for HTTP status codes between 200 and 299.

errorBytes : Bytes Read Only

The returned message body as bytes for HTTP status code greater or equal to 400. Error messages are not written to the response file.

errorText : String Read Only

The returned message body as text for HTTP status code greater or equal to 400. Error messages are not written to the response file.

hostNameVerification : boolean

Determines whether host name verification is enabled.

identity : KeyRef

Gets the identity used for mutual TLS (mTLS).

responseHeaders : Map Read Only

All response headers as a map in which each entry represents an individual header. The key of the entry holds the header name and the entry value holds a list of all header values.

statusCode : Number Read Only

The status code of the last HTTP operation.

statusMessage : String Read Only

The message text of the last HTTP operation.

text : String Read Only

The returned message body as text for HTTP status codes between 200 and 299.

timeout : Number

The timeout for this client, in milliseconds.

Constructor Summary

HTTPClient()

Method Summary

enableCaching(ttl : Number) : void

Calling this method enables caching for GET requests.

getAllowRedirect() : boolean

Determines whether redirect handling is enabled.

getAllResponseHeaders() : HashMap

Returns all response headers as a map containing the name and value of the response header.

getBytes() : Bytes

Returns the bytes in the message body for HTTP status codes between 200 and 299.

getErrorBytes() : Bytes

Returns the returned message body as bytes for HTTP status code greater or equal to 400.

getErrorText() : String

Returns the returned message body as text for HTTP status code greater or equal to 400.

getHostNameVerification() : boolean

Determines whether host name verification is enabled.

getIdentity() : KeyRef

Gets the identity used for mutual TLS (mTLS).

getResponseHeader(header : String) : String

Returns a specific response header from the last HTTP operation.

getResponseHeaders(name : String) : List

Returns all the values of a response header from the last HTTP operation as a list of strings.

getResponseHeaders() : Map

Returns all response headers as a map in which each entry represents an individual header.

getStatusCode() : Number

Returns the status code of the last HTTP operation.

getStatusMessage() : String

Returns the message text of the last HTTP operation.

getText() : String

Returns the returned message body as text for HTTP status codes between 200 and 299.

getText(encoding : String) : String

Returns the returned message body as text for HTTP status codes between 200 and 299.

getTimeout() : Number

Returns the timeout for this client, in milliseconds.

open(method : String, url : String) : void

Opens the specified URL using the specified method.

open(method : String, url : String, async : boolean, user : String, password : String) : void

Deprecated method.

open(method : String, url : String, user : String, password : String) : void

Opens the specified URL with the in parameter method specified Http method with given credentials [user, password] using HTTP basic authentication.

send() : void

Sends an HTTP request.

send(text : String) : void