Represents an HTTP Service.
The HTTP Service will use the return value of the createRequest callback as the request body (if supported by the HTTP method). If this is an array of non-null HTTPRequestPart objects, then a multi-part request will be formed. Otherwise the object is converted to a String and used.
See also XML.toXMLString() and JSON.stringify(Object), which must be explicitly called if needed.
| Property | Description |
|---|---|
| authentication: String | Returns the authentication type. |
| cachingTTL: Number | Returns the caching time to live value. |
client: HTTPClient (read-only) | Returns the underlying HTTP client object. |
| encoding: String | Returns the request body encoding to declare. |
| hostNameVerification: Boolean | Determines whether host name verification is enabled. |
| identity: KeyRef | Gets the identity used for mutual TLS (mTLS). |
| outFile: File | Returns the output file, or null if there is none. |
| requestMethod: String | Returns the request method. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| addHeader(String, String) | Adds an HTTP Header. |
| addParam(String, String) | Adds a query parameter that will be appended to the URL. |
| getAuthentication() | Returns the authentication type. |
| getCachingTTL() | Returns the caching time to live value. |
| getClient() | Returns the underlying HTTP client object. |
| getEncoding() | Returns the request body encoding to declare. |
| getHostNameVerification() | Determines whether host name verification is enabled. |
| getIdentity() | Gets the identity used for mutual TLS (mTLS). |
| getOutFile() | Returns the output file, or null if there is none. |
| getRequestMethod() | Returns the request method. |
| setAuthentication(String) | Sets the type of authentication. |
| setCachingTTL(Number) | Enables caching for GET requests. |
| setEncoding(String) | Sets the encoding of the request body (if any). |
| setHostNameVerification(Boolean) | Sets whether certificate host name verification is enabled. |
| setIdentity(KeyRef) | Sets the identity (private key) to use when mutual TLS (mTLS) is configured. |
| setOutFile(File) | Sets the output file in which to write the HTTP response body. |
| setRequestMethod(String) | Sets the HTTP request method. |
call, getConfiguration, getCredentialID, getRequestData, getResponse, getURL, isMock, isThrowOnError, setCredentialID, setMock, setThrowOnError, setURL
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Returns the authentication type.
Returns the caching time to live value.
See Also:
(read-only)Returns the underlying HTTP client object.
Returns the request body encoding to declare.
Determines whether host name verification is enabled.
Gets the identity used for mutual TLS (mTLS).
Returns the output file, or null if there is none.
Returns the request method.
Adds an HTTP Header.
Parameters:
Returns:
Adds a query parameter that will be appended to the URL.
Parameters:
Returns:
Returns the authentication type.
Returns:
Returns the caching time to live value.
Returns:
See Also:
Returns the underlying HTTP client object.
Returns:
Returns the request body encoding to declare.
Returns:
Determines whether host name verification is enabled.
Returns:
Gets the identity used for mutual TLS (mTLS).
Returns:
Returns the output file, or null if there is none.
Returns:
Returns the request method.
Returns:
Sets the type of authentication. Valid values include "BASIC" and "NONE".
The default value is BASIC.
Parameters:
Returns:
Enables caching for GET requests.
This only caches status codes 2xx with a content length and size of less than 50k that are not immediately written to file. The URL and the user name are used as cache keys. The total size of cacheable content and the number of cached items is limited and automatically managed by the system.
Cache control information sent by the remote server is ignored.
Caching HTTP responses should be done very carefully. It is important to ensure that the response really depends only on the URL and doesn't contain any remote state information or time information which is independent of the URL. It is also important to verify that the application sends exactly the same URL multiple times.
Parameters:
See Also:
Sets the encoding of the request body (if any).
The default value is UTF-8.
Parameters:
Returns:
Sets whether certificate host name verification is enabled. The default value is true. Set it to false to disable host name verification.
Parameters:
Returns:
Sets the identity (private key) to use when mutual TLS (mTLS) is configured.
If this is not set and mTLS is used then the private key will be chosen from the key store based on the host name. If this is set to a reference named "__NONE__" then no private key will be used even if one is requested by the remote server.
Parameters:
Sets the output file in which to write the HTTP response body.
The default behavior is to not write a file.
Parameters:
Returns:
Sets the HTTP request method.
Valid values include GET, PUT, POST, and DELETE.
The default value is POST.
Parameters:
Returns:
j