Functions -
http
createHttpCachingClient |
Creates an HTTP client capable of caching HTTP responses.
|
createHttpSecureClient |
Creates an HTTP client capable of securing HTTP requests with authentication.
|
extractAuthorizationHeaderValue |
Extracts the Authorization header value from the request.
|
invokeEndpoint |
The HEAD remote function implementation of the Circuit Breaker. This wraps the
head function of the underlying
HTTP remote function provider.
|
parseHeader |
Parses the given header value to extract its value and parameter map.
|
createHttpCachingClient
(string url, ClientConfiguration config, CacheConfig cacheConfig)
returns HttpClient | ClientErrorParameters
- url string
-
The URL of the HTTP endpoint to connect
- config ClientConfiguration
-
The configurations for the client endpoint associated with the caching client
- cacheConfig CacheConfig
-
The configurations for the HTTP cache to be used with the caching client
-
Return Type
(HttpClient | ClientError) An
http:HttpCachingClient
instance, which wraps the basehttp:Client
with a caching layer or else anhttp:ClientError
-
Return Type
(HttpClient | ClientError) Created secure HTTP client
Parameters
- req Request
-
The
Request
instance
-
Return Type
(string) Value of the Authorization header
invokeEndpoint
(string path, Request outRequest, HttpOperation requestAction, HttpClient httpClient, string verb)
returns HttpResponse | ClientErrorhead
function of the underlying
HTTP remote function provider.
Parameters
- path string
-
Resource path
- outRequest Request
-
A Request struct
- requestAction HttpOperation
-
HttpOperation
related to the request
- httpClient HttpClient
-
HTTP client which uses to call the relevant functions
- verb string
-
HTTP verb used for submit method
-
Return Type
(HttpResponse | ClientError) The response for the request or an
http:ClientError
if failed to establish communication with the upstream server
Parameters
- headerValue string
-
The header value
-
Return Type
([string, map] | ClientError) A tuple containing the value and its parameter map or else an
http:ClientError
if the header parsing fails