Functions -
http
createHttpCachingClient | Creates an HTTP client capable of caching HTTP responses. |
createHttpSecureClient | Creates an HTTP client capable of securing HTTP requests with authentication. |
decode | Decodes the given URL. |
encode | Encodes the given URL. |
extractAuthorizationHeaderValue | Extracts the Authorization header value from the request. |
invokeEndpoint | The HEAD remote function implementation of the Circuit Breaker. This wraps the |
parseHeader | Parses the given header value to extract its value and parameter map. |
createHttpCachingClient
(string url, ClientEndpointConfig config, CacheConfig cacheConfig)
returns HttpClient | errorCreates an HTTP client capable of caching HTTP responses.
Parameters
- url string
-
The URL of the HTTP endpoint to connect to
- config ClientEndpointConfig
-
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 | error) An
HttpCachingClient
instance which wraps the baseClient
with a caching layer
Creates an HTTP client capable of securing HTTP requests with authentication.
-
Return Type
(HttpClient | error) Created secure HTTP client
Decodes the given URL.
Encodes the given URL.
Extracts the Authorization header value from the request.
Parameters
- req Request
-
Request instance
-
Return Type
(string) Value of the Authorization header
invokeEndpoint
(string path, Request outRequest, HttpOperation requestAction, HttpClient httpClient, string verb)
returns HttpResponse | errorThe HEAD remote function implementation of the Circuit Breaker. This wraps the head()
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 | error) The response for the request or an
error
if failed to establish communication with the upstream server