Modules

http

Module http

ballerina/http Ballerina library

2.12.1

Overview

This module provides APIs for connecting and interacting with HTTP and HTTP2 endpoints. It facilitates two types of network entry points as the Client and Listener.

Client

The Client is used to connect to and interact with HTTP endpoints. They support connection pooling and can be configured to have a maximum number of active connections that can be made with the remote endpoint. The Client activates connection eviction after a given idle period and also supports follow-redirects so that you do not have to manually handle 3xx HTTP status codes.

Resiliency

The Client handles resilience in multiple ways such as load balancing, circuit breaking, endpoint timeouts, and via a retry mechanism.

Load balancing is used in the round-robin or failover manner.

When a failure occurs in the remote service, the client connections might wait for some time before a timeout occurs. Awaiting requests consume resources in the system. Circuit Breakers are used to trip after a certain number of failed requests to the remote service. Once a circuit breaker trips, it does not allow the client to send requests to the remote service for a period of time.

The Ballerina circuit breaker supports tripping on HTTP error status codes and I/O errors. Failure thresholds can be configured based on a sliding window (e.g., 5 failures within 10 seconds). The Client also supports a retry mechanism that allows it to resend failed requests periodically for a given number of times.

Security

The Client supports Server Name Indication (SNI), Certificate Revocation List (CRL), Online Certificate Status Protocol (OCSP), and OCSP Stapling for SSL/TLS connections. Also, the Client can be configured to send authentication information to the endpoint being invoked. Ballerina has built-in support for Basic authentication, JWT authentication, and OAuth2 authentication.

In addition to that, it supports both HTTP/1.1 and HTTP2 protocols and connection keep-alive, content chunking, HTTP caching, data compression/decompression, response payload binding, and authorization can be highlighted as the features of the Clients.

A Client can be defined using the URL of the remote service that it needs to connect with as shown below:


http:Client clientEndpoint = check new("https://my-simple-backend.com");

The defined Client endpoint can be used to call a remote service as follows:


// Send a GET request to the specified endpoint.
http:Response response = check clientEndpoint->get("/get?id=123");

The payload can be retrieved as the return value from the remote function as follows:


// Retrieve payload as json.
json payload = check clientEndpoint->post("/backend/Json", "foo");

Listener

The Listener is the underneath server connector that binds the given IP/Port to the network and it's behavior can be changed using the http:ListenerConfiguration. In HTTP, the http:Service-typed services can be attached to the Listener. The service type precisely describes the syntax for both the service and resource.

A Service represents a collection of network-accessible entry points and can be exposed via a Listener endpoint. A resource represents one such entry point and can have its own path, HTTP methods, body format, consumes and produces content types, CORS headers, etc. In resources, the HTTP method and resource path are mandatory parameters and the String literal and path parameters can be stated as the path. The resource function accepts the http:Caller, http:Request, http:Headers, query parameters, header parameters, and payload parameters as arguments. However, they are optional.

When a Service receives a request, it is dispatched to the best-matched resource.

A Listener endpoint can be defined as follows:


// Attributes associated with the `Listener` endpoint are defined here.
listener http:Listener helloWorldEP = new(9090);

Then a Service can be defined and attached to the above Listener endpoint as shown below:


// By default, Ballerina assumes that the service is to be exposed via HTTP/1.1.
service /helloWorld on helloWorldEP {

   resource function post [string name](@http:Payload string message) returns string {
       // Sends the response back to the client along with a string payload.
       return "Hello, World! I’m " + name + ". " + message;
   }
}

Security

Listener endpoints can be exposed via SSL. They support Mutual SSL, Hostname Verification, and Application Layer Protocol Negotiation (ALPN) for HTTP2. Listener endpoints also support Certificate Revocation List (CRL), Online Certificate Status Protocol (OCSP), and OCSP Stapling. Also, The listener can be configured to authenticate and authorize the inbound requests. Ballerina has built-in support for basic authentication, JWT authentication, and OAuth2 authentication.

In addition to that, supports both the HTTP/1.1 and HTTP2 protocols and connection keep-alive, content chunking, HTTP caching, data compression/decompression, payload binding, and authorization can be highlighted as the features of a Service.

Functions

authenticateResource

Isolated Function

function authenticateResource(Service serviceRef, string methodName, string[] resourcePath)

Uses for declarative auth design, where the authentication/authorization decision is taken by reading the auth annotations provided in service/resource and the Authorization header of request.

Parameters

serviceRef Service - The service reference where the resource locates

methodName string - The name of the subjected resource

resourcePath string[] - The relative path

createHttpCachingClient

Isolated Function

function createHttpCachingClient(string url, ClientConfiguration config, CacheConfig cacheConfig) returns HttpClient|ClientError

Creates an HTTP client capable of caching HTTP responses.

Parameters

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 base http:Client with a caching layer or else an http:ClientError

createHttpSecureClient

Isolated Function

function createHttpSecureClient(string url, ClientConfiguration config) returns HttpClient|ClientError

Creates an HTTP client capable of securing HTTP requests with authentication.

Parameters

url string - Base URL

config ClientConfiguration - Client endpoint configurations

Return Type

HttpClient|ClientError - Created secure HTTP client

parseHeader

Isolated Function

function parseHeader(string headerValue) returns HeaderValue[]|ClientError

Parses the header value which contains multiple values or parameters.


http:HeaderValue[] values = check http:parseHeader("text/plain;level=1;q=0.6, application/xml;level=2");

Parameters

headerValue string - The header value

Return Type

HeaderValue[]|ClientError - An array of http:HeaderValue typed record containing the value and its parameter map or else an http:ClientError if the header parsing fails

Classes

http: ClientBasicAuthHandler

Isolated

Defines the Basic Auth handler for client authentication.

Constructor

Initializes the http:ClientBasicAuthHandler object.

init (CredentialsConfig config)

config CredentialsConfig - The http:CredentialsConfig instance

enrich

Isolated Function

function enrich(Request req) returns Request|ClientAuthError

Enrich the request with the relevant authentication requirements.

Parameters

req Request - The http:Request instance

Return Type

Request|ClientAuthError - The updated http:Request instance or else an http:ClientAuthError in case of an error

enrichHeaders

Isolated Function

function enrichHeaders(map<string|string[]> headers) returns map<string|string[]>|ClientAuthError

Enrich the headers map with the relevant authentication requirements.

Parameters

headers map<string|string[]> - The headers map

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

getSecurityHeaders

Isolated Function

function getSecurityHeaders() returns map<string|string[]>|ClientAuthError

Returns the headers map with the relevant authentication requirements.

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

http: ClientBearerTokenAuthHandler

Isolated

Defines the Bearer token auth handler for client authentication.

Constructor

Initializes the http:ClientBearerTokenAuthHandler object.

init (BearerTokenConfig config)

config BearerTokenConfig - The http:BearerTokenConfig instance

enrich

Isolated Function

function enrich(Request req) returns Request|ClientAuthError

Enrich the request with the relevant authentication requirements.

Parameters

req Request - The http:Request instance

Return Type

Request|ClientAuthError - The updated http:Request instance or else an http:ClientAuthError in case of an error

enrichHeaders

Isolated Function

function enrichHeaders(map<string|string[]> headers) returns map<string|string[]>|ClientAuthError

Enrich the headers map with the relevant authentication requirements.

Parameters

headers map<string|string[]> - The headers map

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

getSecurityHeaders

Isolated Function

function getSecurityHeaders() returns map<string|string[]>|ClientAuthError

Returns the headers map with the relevant authentication requirements.

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

http: ClientSelfSignedJwtAuthHandler

Isolated

Defines the self signed JWT handler for client authentication.

Constructor

Initializes the http:ClientSelfSignedJwtAuthProvider object.

init (JwtIssuerConfig config)

config JwtIssuerConfig - The http:JwtIssuerConfig instance

enrich

Isolated Function

function enrich(Request req) returns Request|ClientAuthError

Enrich the request with the relevant authentication requirements.

Parameters

req Request - The http:Request instance

Return Type

Request|ClientAuthError - The updated http:Request instance or else an http:ClientAuthError in case of an error

enrichHeaders

Isolated Function

function enrichHeaders(map<string|string[]> headers) returns map<string|string[]>|ClientAuthError

Enrich the headers map with the relevant authentication requirements.

Parameters

headers map<string|string[]> - The headers map

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

getSecurityHeaders

Isolated Function

function getSecurityHeaders() returns map<string|string[]>|ClientAuthError

Returns the headers map with the relevant authentication requirements.

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

Read Only

Represents a Cookie.

Initializes the http:Cookie object.

init (string name, string value, *CookieOptions options)

name string - Name of the http:Cookie

value string - Value of the http:Cookie

options *CookieOptions - The options to be used when initializing the http:Cookie

Isolated Function

function isPersistent() returns boolean

Checks the persistence of the cookie.

Return Type

boolean - false if the cookie will be discarded at the end of the "session" or else true.

Isolated Function

function isValid() returns boolean|InvalidCookieError

Checks the validity of the attributes of the cookie.

Return Type

boolean|InvalidCookieError - true if the attributes of the cookie are in the correct format or else an http:InvalidCookieError

Isolated Function

function toStringValue() returns string

Gets the Cookie object in its string representation to be used in the ‘Set-Cookie’ header of the response.

Return Type

string - The string value of the http:Cookie

Fields

name string - Name of the cookie

value string - Value of the cookie

path string? - URI path to which the cookie belongs

domain string? - Host to which the cookie will be sent

expires string? - Maximum lifetime of the cookie represented as the date and time at which the cookie expires

maxAge int - Maximum lifetime of the cookie represented as the number of seconds until the cookie expires

httpOnly boolean - Cookie is sent only to HTTP requests

secure boolean - Cookie is sent only to secure channels

createdTime Utc - At what time the cookie was created

lastAccessedTime Utc - Last-accessed time of the cookie

hostOnly boolean - Cookie is sent only to the requested host

http: CookieStore

Isolated

Represents the cookie store.

addCookie

Isolated Function

function addCookie(Cookie cookie, CookieConfig cookieConfig, string url, string requestPath) returns CookieHandlingError?

Adds a cookie to the cookie store according to the rules in RFC-6265.

Parameters

cookie Cookie - Cookie to be added

cookieConfig CookieConfig - Configurations associated with the cookies

url string - Target service URL

requestPath string - Resource path

Return Type

CookieHandlingError? - An http:CookieHandlingError if there is any error occurred when adding a cookie or else ()

addCookies

Isolated Function

function addCookies(Cookie[] cookiesInResponse, CookieConfig cookieConfig, string url, string requestPath)

Adds an array of cookies.

Parameters

cookiesInResponse Cookie[] - Cookies to be added

cookieConfig CookieConfig - Configurations associated with the cookies

url string - Target service URL

requestPath string - Resource path

getCookies

Isolated Function

function getCookies(string url, string requestPath) returns Cookie[]

Gets the relevant cookies for the given URL and the path according to the rules in RFC-6265.

Parameters

url string - URL of the request URI

requestPath string - Path of the request URI

Return Type

Cookie[] - Array of the matched cookies stored in the cookie store

getAllCookies

Isolated Function

function getAllCookies() returns Cookie[]

Gets all the cookies in the cookie store.

Return Type

Cookie[] - Array of all the cookie objects

getCookiesByName

Isolated Function

function getCookiesByName(string cookieName) returns Cookie[]

Gets all the cookies, which have the given name as the name of the cookie.

Parameters

cookieName string - Name of the cookie

Return Type

Cookie[] - Array of all the matched cookie objects

getCookiesByDomain

Isolated Function

function getCookiesByDomain(string domain) returns Cookie[]

Gets all the cookies, which have the given name as the domain of the cookie.

Parameters

domain string - Name of the domain

Return Type

Cookie[] - Array of all the matched cookie objects

removeCookie

Isolated Function

function removeCookie(string name, string domain, string path) returns CookieHandlingError?

Removes a specific cookie.

Parameters

name string - Name of the cookie to be removed

domain string - Domain of the cookie to be removed

path string - Path of the cookie to be removed

Return Type

CookieHandlingError? - An http:CookieHandlingError if there is any error occurred during the removal of the cookie or else ()

removeCookiesByDomain

Isolated Function

function removeCookiesByDomain(string domain) returns CookieHandlingError?

Removes cookies, which match with the given domain.

Parameters

domain string - Domain of the cookie to be removed

Return Type

CookieHandlingError? - An http:CookieHandlingError if there is any error occurred during the removal of cookies by domain or else ()

removeExpiredCookies

Isolated Function

function removeExpiredCookies() returns CookieHandlingError?

Removes all expired cookies.

Return Type

CookieHandlingError? - An http:CookieHandlingError if there is any error occurred during the removal of expired cookies or else ()

removeAllCookies

Isolated Function

function removeAllCookies() returns CookieHandlingError?

Removes all the cookies.

Return Type

CookieHandlingError? - An http:CookieHandlingError if there is any error occurred during the removal of all the cookies or else ()

http: CsvPersistentCookieHandler

Isolated

Represents a default persistent cookie handler, which stores persistent cookies in a CSV file.

storeCookie

Isolated Function

function storeCookie(Cookie cookie) returns CookieHandlingError?

Adds a persistent cookie to the cookie store.

Parameters

cookie Cookie - Cookie to be added

Return Type

CookieHandlingError? - An error will be returned if there is any error occurred during the storing process of the cookie or else nil is returned

getAllCookies

Isolated Function

function getAllCookies() returns Cookie[]|CookieHandlingError

Gets all the persistent cookies.

Return Type

Cookie[]|CookieHandlingError - Array of persistent cookies stored in the cookie store or else an error is returned if one occurred during the retrieval of the cookies

removeCookie

Isolated Function

function removeCookie(string name, string domain, string path) returns CookieHandlingError?

Removes a specific persistent cookie.

Parameters

name string - Name of the persistent cookie to be removed

domain string - Domain of the persistent cookie to be removed

path string - Path of the persistent cookie to be removed

Return Type

CookieHandlingError? - An error will be returned if there is any error occurred during the removal of the cookie or else nil is returned

removeAllCookies

Isolated Function

function removeAllCookies() returns CookieHandlingError?

Removes all persistent cookies.

Return Type

CookieHandlingError? - An error will be returned if there is any error occurred during the removal of all the cookies or else nil is returned

http: DefaultStatus

Read Only

The default status code class.

Fields

Fields Included from *Status

code int

http: Headers

Represents the headers of the inbound request.

hasHeader

Isolated Function

function hasHeader(string headerName) returns boolean

Checks whether the requested header key exists in the header map.

Parameters

headerName string - The header name

Return Type

boolean - true if the specified header key exists

getHeader

Isolated Function

function getHeader(string headerName) returns string|HeaderNotFoundError

Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.

Parameters

headerName string - The header name

Return Type

string|HeaderNotFoundError - The first header value for the specified header name or the HeaderNotFoundError if the header is not found.

getHeaders

Isolated Function

function getHeaders(string headerName) returns string[]|HeaderNotFoundError

Gets all the header values to which the specified header key maps to.

Parameters

headerName string - The header name

Return Type

string[]|HeaderNotFoundError - The header values the specified header key maps to or the HeaderNotFoundError if the header is not found.

getHeaderNames

Isolated Function

function getHeaderNames() returns string[]

Gets all the names of the headers of the request.

Return Type

string[] - An array of all the header names

http: HttpCache

Isolated

Implements a cache for storing HTTP responses. This cache complies with the caching policy set when configuring HTTP caching in the HTTP client endpoint.

Constructor

Creates the HTTP cache.

init (CacheConfig cacheConfig)

cacheConfig CacheConfig - The configurations for the HTTP cache

http: HttpFuture

Represents a 'future' that returns as a result of an asynchronous HTTP request submission. This can be used as a reference to fetch the results of the submission.

http: ListenerFileUserStoreBasicAuthHandler

Isolated

Defines the file store Basic Auth handler for listener authentication.

Constructor

Initializes the http:ListenerFileUserStoreBasicAuthHandler object.

init (FileUserStoreConfig config)

config FileUserStoreConfig {} - The http:FileUserStoreConfig instance

authenticate

Isolated Function

function authenticate(Request|Headers|string data) returns UserDetails|Unauthorized

Authenticates with the relevant authentication requirements.

Parameters

data Request|Headers|string - The http:Request instance or http:Headers instance or string Authorization header

Return Type

UserDetails|Unauthorized - The auth:UserDetails instance or else Unauthorized type in case of an error

authorize

Isolated Function

function authorize(UserDetails userDetails, string|string[] expectedScopes) returns Forbidden?

Authorizes with the relevant authorization requirements.

Parameters

userDetails UserDetails - The auth:UserDetails instance which is received from authentication results

expectedScopes string|string[] - The expected scopes as string or string[]

Return Type

Forbidden? - (), if it is successful or else Forbidden type in case of an error

http: ListenerJwtAuthHandler

Isolated

Defines the JWT auth handler for listener authentication.

Constructor

Initializes the http:ListenerJwtAuthHandler object.

init (JwtValidatorConfig config)

config JwtValidatorConfig - The http:JwtValidatorConfig instance

authenticate

Isolated Function

function authenticate(Request|Headers|string data) returns Payload|Unauthorized

Authenticates with the relevant authentication requirements.

Parameters

data Request|Headers|string - The http:Request instance or http:Headers instance or string Authorization header

Return Type

Payload|Unauthorized - The jwt:Payload instance or else Unauthorized type in case of an error

authorize

Isolated Function

function authorize(Payload jwtPayload, string|string[] expectedScopes) returns Forbidden?

Authorizes with the relevant authorization requirements.

Parameters

jwtPayload Payload - The jwt:Payload instance which is received from authentication results

expectedScopes string|string[] - The expected scopes as string or string[]

Return Type

Forbidden? - (), if it is successful or else Forbidden type in case of an error

http: LoadBalancerRoundRobinRule

Isolated

Implementation of round robin load balancing strategy.

getNextClient

Isolated Function

function getNextClient(Client?[] loadBalanceCallerActionsArray) returns Client|ClientError

Provides an HTTP client, which is chosen according to the round robin algorithm.

Parameters

loadBalanceCallerActionsArray Client?[] - Array of HTTP clients, which needs to be load balanced

Return Type

Client|ClientError - Chosen http:Client from the algorithm or else an http:ClientError for a failure in the algorithm implementation

http: PushPromise

Represents an HTTP/2 PUSH_PROMISE frame.

Constructor

Constructs an http:PushPromise from a given path and a method.

init (string path, string method)

path string "/" - The resource path

method string "GET" - The HTTP method

hasHeader

Isolated Function

function hasHeader(string headerName) returns boolean

Checks whether the requested header exists.

Parameters

headerName string - The header name

Return Type

boolean - A boolean representing the existence of a given header

getHeader

Isolated Function

function getHeader(string headerName) returns string

Returns the header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Parameters

headerName string - The header name

Return Type

string - The header value or () if there is no such header

getHeaders

Isolated Function

function getHeaders(string headerName) returns string[]

Gets transport headers from the PushPromise.

Parameters

headerName string - The header name

Return Type

string[] - The array of header values

addHeader

Isolated Function

function addHeader(string headerName, string headerValue)

Adds the specified key/value pair as an HTTP header to the http:PushPromise.

Parameters

headerName string - The header name

headerValue string - The header value

setHeader

Isolated Function

function setHeader(string headerName, string headerValue)

Sets the value of a transport header in the http:PushPromise.

Parameters

headerName string - The header name

headerValue string - The header value

removeHeader

Isolated Function

function removeHeader(string headerName)

Removes a transport header from the http:PushPromise.

Parameters

headerName string - The header name

removeAllHeaders

Isolated Function

function removeAllHeaders()

Removes all transport headers from the http:PushPromise.

getHeaderNames

Isolated Function

function getHeaderNames() returns string[]

Gets all transport header names from the http:PushPromise.

Return Type

string[] - An array of all transport header names

Fields

path string - The resource path

method string - The HTTP method

http: Request

Represents an HTTP request.

setEntity

Isolated Function

function setEntity(Entity e)

Sets the provided Entity to the request.

Parameters

e Entity - The Entity to be set to the request

getQueryParams

Isolated Function

function getQueryParams() returns map<string[]>

Gets the query parameters of the request as a map consisting of a string array.

Return Type

map<string[]> - String array map of the query params

getQueryParamValue

Isolated Function

function getQueryParamValue(string key) returns string?

Gets the query param value associated with the given key.

Parameters

key string - Represents the query param key

Return Type

string? - The query param value associated with the given key as a string. If multiple param values are present, then the first value is returned. () is returned if no key is found.

getQueryParamValues

Isolated Function

function getQueryParamValues(string key) returns string[]?

Gets all the query param values associated with the given key.

Parameters

key string - Represents the query param key

Return Type

string[]? - All the query param values associated with the given key as a string[]. () is returned if no key is found.

getMatrixParams

Isolated Function

function getMatrixParams(string path) returns map<any>

Gets the matrix parameters of the request.

Parameters

path string - Path to the location of matrix parameters

Return Type

map<any> - A map of matrix parameters which can be found for the given path

getEntity

Isolated Function

function getEntity() returns Entity|ClientError

Gets the Entity associated with the request.

Return Type

Entity|ClientError - The Entity of the request. An http:ClientError is returned, if entity construction fails

hasHeader

Isolated Function

function hasHeader(string headerName) returns boolean

Checks whether the requested header key exists in the header map.

Parameters

headerName string - The header name

Return Type

boolean - true if the specified header key exists

getHeader

Isolated Function

function getHeader(string headerName) returns string|HeaderNotFoundError

Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.

Parameters

headerName string - The header name

Return Type

string|HeaderNotFoundError - The first header value for the specified header name or the HeaderNotFoundError if the header is not found.

getHeaders

Isolated Function

function getHeaders(string headerName) returns string[]|HeaderNotFoundError

Gets all the header values to which the specified header key maps to.

Parameters

headerName string - The header name

Return Type

string[]|HeaderNotFoundError - The header values the specified header key maps to or the HeaderNotFoundError if the header is not found.

setHeader

Isolated Function

function setHeader(string headerName, string headerValue)

Sets the specified header to the request. If a mapping already exists for the specified header key, the existing header value is replaced with the specified header value. Panic if an illegal header is passed.

Parameters

headerName string - The header name

headerValue string - The header value

addHeader

Isolated Function

function addHeader(string headerName, string headerValue)

Adds the specified header to the request. Existing header values are not replaced. Panic if an illegal header is passed.

Parameters

headerName string - The header name

headerValue string - The header value

removeHeader

Isolated Function

function removeHeader(string headerName)

Removes the specified header from the request.

Parameters

headerName string - The header name

removeAllHeaders

Isolated Function

function removeAllHeaders()

Removes all the headers from the request.

getHeaderNames

Isolated Function

function getHeaderNames() returns string[]

Gets all the names of the headers of the request.

Return Type

string[] - An array of all the header names

expects100Continue

Isolated Function

function expects100Continue() returns boolean

Checks whether the client expects a 100-continue response.

Return Type

boolean - true if the client expects a 100-continue response

setContentType

Isolated Function

function setContentType(string contentType) returns error?

Sets the content-type header to the request.

Parameters

contentType string - Content type value to be set as the content-type header

Return Type

error? - Nil if successful, error in case of invalid content-type

getContentType

Isolated Function

function getContentType() returns string

Gets the type of the payload of the request (i.e: the content-type header value).

Return Type

string - The content-type header value as a string

getJsonPayload

Isolated Function

function getJsonPayload() returns json|ClientError

Extract json payload from the request. For an empty payload, http:NoContentError is returned.

If the content type is not JSON, an http:ClientError is returned.

Return Type

json|ClientError - The json payload or http:ClientError in case of errors

getXmlPayload

Isolated Function

function getXmlPayload() returns xml|ClientError

Extracts xml payload from the request. For an empty payload, http:NoContentError is returned.

If the content type is not XML, an http:ClientError is returned.

Return Type

xml|ClientError - The xml payload or http:ClientError in case of errors

getTextPayload

Isolated Function

function getTextPayload() returns string|ClientError

Extracts text payload from the request. For an empty payload, http:NoContentError is returned.

If the content type is not of type text, an http:ClientError is returned.

Return Type

string|ClientError - The text payload or http:ClientError in case of errors

getByteStream

Isolated Function

function getByteStream(int arraySize) returns stream<byte[], Error?>|ClientError

Gets the request payload as a stream of byte[], except in the case of multiparts. To retrieve multiparts, use Request.getBodyParts().

Parameters

arraySize int (default 8192) - A defaultable parameter to state the size of the byte array. Default size is 8KB

Return Type

stream<byte[], Error?>|ClientError - A byte stream from which the message payload can be read or http:ClientError in case of errors

getBinaryPayload

Isolated Function

function getBinaryPayload() returns byte[]|ClientError

Gets the request payload as a byte[].

Return Type

byte[]|ClientError - The byte[] representation of the message payload or http:ClientError in case of errors

getFormParams

Isolated Function

function getFormParams() returns map<string>|ClientError

Gets the form parameters from the HTTP request as a map when content type is application/x-www-form-urlencoded.

Return Type

map<string>|ClientError - The map of form params or http:ClientError in case of errors

getBodyParts

Isolated Function

function getBodyParts() returns Entity[]|ClientError

Extracts body parts from the request. If the content type is not a composite media type, an error is returned.

Return Type

Entity[]|ClientError - The body parts as an array of entities or else an http:ClientError if there were any errors constructing the body parts from the request

setJsonPayload

Isolated Function

function setJsonPayload(json payload, string? contentType)

Sets a json as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/json. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

payload json - The json payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/json is the default value

setXmlPayload

Isolated Function

function setXmlPayload(xml payload, string? contentType)

Sets an xml as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/xml. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

payload xml - The xml payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/xml is the default value

setTextPayload

Isolated Function

function setTextPayload(string payload, string? contentType)

Sets a string as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is text/plain. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

payload string - The string payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The text/plain is the default value

setBinaryPayload

Isolated Function

function setBinaryPayload(byte[] payload, string? contentType)

Sets a byte[] as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/octet-stream. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

payload byte[] - The byte[] payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/octet-stream is the default value

setBodyParts

Isolated Function

function setBodyParts(Entity[] bodyParts, string? contentType)

Set multiparts as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is multipart/form-data. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

bodyParts Entity[] - The entities which make up the message body

contentType string? (default ()) - The content type of the top level message. This is an optional parameter. The multipart/form-data is the default value

setFileAsPayload

Isolated Function

function setFileAsPayload(string filePath, string? contentType)

Sets the content of the specified file as the entity body of the request. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/octet-stream. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

filePath string - Path to the file to be set as the payload

contentType string? (default ()) - The content type of the specified file. This is an optional parameter. The application/octet-stream is the default value

setByteStream

Isolated Function

function setByteStream(stream<byte[], Error?> byteStream, string? contentType)

Sets a Stream as the payload. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/octet-stream. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

byteStream stream<byte[], Error?> - Byte stream, which needs to be set to the request

contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter. The application/octet-stream is the default value

setPayload

Isolated Function

function setPayload(string|xml|json|byte[]|Entity[]|stream<byte[], Error?> payload, string? contentType)

Sets the request payload. This method overrides any existing content-type by passing the content-type as an optional parameter. If the content type parameter is not provided then the default value derived from the payload will be used as content-type only when there are no existing content-type header.

Parameters

payload string|xml|json|byte[]|Entity[]|stream<byte[], Error?> - Payload can be of type string, xml, json, byte[], stream<byte[], io:Error?> or Entity[] (i.e., a set of body parts).

contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter

addCookies

Isolated Function

function addCookies(Cookie[] cookiesToAdd)

Adds cookies to the request.

Parameters

cookiesToAdd Cookie[] - Represents the cookies to be added

getCookies

Isolated Function

function getCookies() returns Cookie[]

Gets cookies from the request.

Return Type

Cookie[] - An array of cookie objects, which are included in the request

Fields

rawPath string(default "") - Resource path of the request URL

method string(default "") - The HTTP request method

httpVersion string(default "") - The HTTP version supported by the client

userAgent string(default "") - The user-agent. This value is used when setting the user-agent header

extraPathInfo string(default "") - The part of the URL, which matched to '*' if the request is dispatched to a wildcard resource

cacheControl RequestCacheControl?(default ()) - The cache-control directives for the request. This needs to be explicitly initialized if intending on utilizing HTTP caching.

mutualSslHandshake MutualSslHandshake?(default ()) - A record providing mutual ssl handshake results.

http: RequestCacheControl

Configures the cache control directives for an http:Request.

buildCacheControlDirectives

Isolated Function

function buildCacheControlDirectives() returns string

Builds the cache control directives string from the current http:RequestCacheControl configurations.

Return Type

string - The cache control directives string to be used in the cache-control header

Fields

noCache boolean(default false) - Sets the no-cache directive

noStore boolean(default false) - Sets the no-store directive

noTransform boolean(default false) - Sets the no-transform directive

onlyIfCached boolean(default false) - Sets the only-if-cached directive

maxAge decimal(default -1) - Sets the max-age directive

maxStale decimal(default -1) - Sets the max-stale directive

minFresh decimal(default -1) - Sets the min-fresh directive

http: RequestContext

Isolated

Represents an HTTP Context that allows user to pass data between interceptors.

set

Isolated Function

function set(string key, ReqCtxMember value)

Sets a member to the request context object.

Parameters

key string - Represents the member key

value ReqCtxMember - Represents the member value

get

Isolated Function

function get(string key) returns ReqCtxMember

Gets a member value from the request context object. It panics if there is no such member.

Parameters

key string - Represents the member key

Return Type

ReqCtxMember - Member value

hasKey

Isolated Function

function hasKey(string key) returns boolean

Checks whether the request context object has a member corresponds to the key.

Parameters

key string - Represents the member key

Return Type

boolean - true if the member exists, else false

keys

Isolated Function

function keys() returns string[]

Returns the member keys of the request context object.

Return Type

string[] - Array of member keys

getWithType

Isolated Function

function getWithType(string key, ReqCtxMemberType targetType) returns targetType|ListenerError

Gets a member value with type from the request context object.

Parameters

key string - Represents the member key

targetType ReqCtxMemberType (default <>) - Represents the expected type of the member value

Return Type

targetType|ListenerError - Attribute value or an error. The error is returned if the member does not exist or if the member value is not of the expected type

remove

Isolated Function

function remove(string key)

Removes a member from the request context object. It panics if there is no such member.

Parameters

key string - Represents the member key

Isolated Function

function next() returns NextService|error?

Calls the next service in the interceptor pipeline.

Return Type

NextService|error? - The next service object in the pipeline. An error is returned, if the call fails

http: Response

Represents an HTTP response.

getEntity

Isolated Function

function getEntity() returns Entity|ClientError

Gets the Entity associated with the response.

Return Type

Entity|ClientError - The Entity of the response. An http:ClientError is returned, if entity construction fails

setEntity

Isolated Function

function setEntity(Entity e)

Sets the provided Entity to the response.

Parameters

e Entity - The Entity to be set to the response

hasHeader

Isolated Function

function hasHeader(string headerName, HeaderPosition position) returns boolean

Checks whether the requested header key exists in the header map.

Parameters

headerName string - The header name

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter

Return Type

boolean - true if the specified header key exists

getHeader

Isolated Function

function getHeader(string headerName, HeaderPosition position) returns string|HeaderNotFoundError

Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.

Parameters

headerName string - The header name

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

Return Type

string|HeaderNotFoundError - The first header value for the specified header name or the HeaderNotFoundError if the header is not found.

addHeader

Isolated Function

function addHeader(string headerName, string headerValue, HeaderPosition position)

Adds the specified header to the response. Existing header values are not replaced. Panic if an illegal header is passed.

Parameters

headerName string - The header name

headerValue string - The header value

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

getHeaders

Isolated Function

function getHeaders(string headerName, HeaderPosition position) returns string[]|HeaderNotFoundError

Gets all the header values to which the specified header key maps to.

Parameters

headerName string - The header name

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

Return Type

string[]|HeaderNotFoundError - The header values the specified header key maps to or the HeaderNotFoundError if the header is not found.

setHeader

Isolated Function

function setHeader(string headerName, string headerValue, HeaderPosition position)

Sets the specified header to the response. If a mapping already exists for the specified header key, the existing header value is replaced with the specified header value. Panic if an illegal header is passed.

Parameters

headerName string - The header name

headerValue string - The header value

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

removeHeader

Isolated Function

function removeHeader(string headerName, HeaderPosition position)

Removes the specified header from the response.

Parameters

headerName string - The header name

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

removeAllHeaders

Isolated Function

function removeAllHeaders(HeaderPosition position)

Removes all the headers from the response.

Parameters

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

getHeaderNames

Isolated Function

function getHeaderNames(HeaderPosition position) returns string[]

Gets all the names of the headers of the response.

Parameters

position HeaderPosition (default LEADING) - Represents the position of the header as an optional parameter. If the position is http:TRAILING, the entity-body of the Response must be accessed initially.

Return Type

string[] - An array of all the header names

setContentType

Isolated Function

function setContentType(string contentType) returns error?

Sets the content-type header to the response.

Parameters

contentType string - Content type value to be set as the content-type header

Return Type

error? - Nil if successful, error in case of invalid content-type

getContentType

Isolated Function

function getContentType() returns string

Gets the type of the payload of the response (i.e., the content-type header value).

Return Type

string - The content-type header value as a string

getJsonPayload

Isolated Function

function getJsonPayload() returns json|ClientError

Extract json payload from the response. For an empty payload, http:NoContentError is returned.

If the content type is not JSON, an http:ClientError is returned.

Return Type

json|ClientError - The json payload or http:ClientError in case of errors

getXmlPayload

Isolated Function

function getXmlPayload() returns xml|ClientError

Extracts xml payload from the response. For an empty payload, http:NoContentError is returned.

If the content type is not XML, an http:ClientError is returned.

Return Type

xml|ClientError - The xml payload or http:ClientError in case of errors

getTextPayload

Isolated Function

function getTextPayload() returns string|ClientError

Extracts text payload from the response. For an empty payload, http:NoContentError is returned.

If the content type is not of type text, an http:ClientError is returned.

Return Type

string|ClientError - The string representation of the message payload or http:ClientError in case of errors

getByteStream

Isolated Function

function getByteStream(int arraySize) returns stream<byte[], Error?>|ClientError

Gets the response payload as a stream of byte[], except in the case of multiparts. To retrieve multiparts, use Response.getBodyParts().

Parameters

arraySize int (default 8192) - A defaultable parameter to state the size of the byte array. Default size is 8KB

Return Type

stream<byte[], Error?>|ClientError - A byte stream from which the message payload can be read or http:ClientError in case of errors

getBinaryPayload

Isolated Function

function getBinaryPayload() returns byte[]|ClientError

Gets the response payload as a byte[].

Return Type

byte[]|ClientError - The byte[] representation of the message payload or http:ClientError in case of errors

getSseEventStream

Isolated Function

function getSseEventStream() returns stream<SseEvent, error?>|ClientError

Gets the response payload as a stream of SseEvent.

Return Type

stream<SseEvent, error?>|ClientError - A SseEvent stream from which the http:SseEvent can be read or http:ClientError in case of errors

getBodyParts

Isolated Function

function getBodyParts() returns Entity[]|ClientError

Extracts body parts from the response. If the content type is not a composite media type, an error is returned.

Return Type

Entity[]|ClientError - The body parts as an array of entities or else an http:ClientError if there were any errors in constructing the body parts from the response

setETag

Isolated Function

function setETag(json|xml|string|byte[] payload)

Sets the etag header for the given payload. The ETag is generated using a CRC32 hash isolated function.

Parameters

payload json|xml|string|byte[] - The payload for which the ETag should be set

setLastModified

Isolated Function

function setLastModified()

Sets the current time as the last-modified header.

setJsonPayload

Isolated Function

function setJsonPayload(json payload, string? contentType)

Parameters

payload json - The json payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/json is the default value

setXmlPayload

Isolated Function

function setXmlPayload(xml payload, string? contentType)

Parameters

payload xml - The xml payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/xml is the default value

setTextPayload

Isolated Function

function setTextPayload(string payload, string? contentType)

Parameters

payload string - The string payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The text/plain is the default value

setBinaryPayload

Isolated Function

function setBinaryPayload(byte[] payload, string? contentType)

Parameters

payload byte[] - The byte[] payload

contentType string? (default ()) - The content type of the payload. This is an optional parameter. The application/octet-stream is the default value

setBodyParts

Isolated Function

function setBodyParts(Entity[] bodyParts, string? contentType)

Parameters

bodyParts Entity[] - The entities which make up the message body

contentType string? (default ()) - The content type of the top level message. This is an optional parameter. The multipart/form-data is the default value

setFileAsPayload

Isolated Function

function setFileAsPayload(string filePath, string? contentType)

Sets the content of the specified file as the entity body of the response. If the content-type header is not set then this method set content-type headers with the default content-type, which is application/octet-stream. Any existing content-type can be overridden by passing the content-type as an optional parameter.

Parameters

filePath string - Path to the file to be set as the payload

contentType string? (default ()) - The content type of the specified file. This is an optional parameter. The application/octet-stream is the default value

setByteStream

Isolated Function

function setByteStream(stream<byte[], Error?> byteStream, string? contentType)

Parameters

byteStream stream<byte[], Error?> - Byte stream, which needs to be set to the response

contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter. The application/octet-stream is the default value

setSseEventStream

Isolated Function

function setSseEventStream(stream<SseEvent, error?>|stream<SseEvent, error> eventStream)

Sets an http:SseEvent stream as the payload, along with the Content-Type and Cache-Control headers set to 'text/event-stream' and 'no-cache', respectively.

Parameters

eventStream stream<SseEvent, error?>|stream<SseEvent, error> - SseEvent stream, which needs to be set to the response

setPayload

Isolated Function

function setPayload(string|xml|json|byte[]|Entity[]|stream<byte[], Error?>|stream<SseEvent, error?> payload, string? contentType)

Sets the response payload. This method overrides any existing content-type by passing the content-type as an optional parameter. If the content type parameter is not provided then the default value derived from the payload will be used as content-type only when there are no existing content-type header.

Parameters

payload string|xml|json|byte[]|Entity[]|stream<byte[], Error?>|stream<SseEvent, error?> - Payload can be of type string, xml, json, byte[], stream<byte[], io:Error?> or Entity[] (i.e., a set of body parts).

contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter

addCookie

Isolated Function

function addCookie(Cookie cookie)

Adds the cookie to response.

Parameters

cookie Cookie - The cookie, which is added to response

removeCookiesFromRemoteStore

Isolated Function

function removeCookiesFromRemoteStore(Cookie... cookiesToRemove)

Deletes the cookies in the client's cookie store.

Parameters

cookiesToRemove Cookie... - Cookies to be deleted

getCookies

Isolated Function

function getCookies() returns Cookie[]

Gets cookies from the response.

Return Type

Cookie[] - An array of cookie objects, which are included in the response

Fields

statusCode int(default 200) - The response status code

reasonPhrase string(default "") - The status code reason phrase

server string(default "") - The server header

resolvedRequestedURI string(default "") - The ultimate request URI that was made to receive the response when redirect is on

cacheControl ResponseCacheControl?(default ()) - The cache-control directives for the response. This needs to be explicitly initialized if intending on utilizing HTTP caching. For incoming responses, this will already be populated if the response was sent with cache-control directives

http: ResponseCacheControl

Configures cache control directives for an http:Response.

populateFields

Isolated Function

function populateFields(HttpCacheConfig cacheConfig)

Parameters

cacheConfig HttpCacheConfig -

buildCacheControlDirectives

Isolated Function

function buildCacheControlDirectives() returns string

Builds the cache control directives string from the current http:ResponseCacheControl configurations.

Return Type

string - The cache control directives string to be used in the cache-control header

Fields

mustRevalidate boolean(default false) - Sets the must-revalidate directive

noCache boolean(default false) - Sets the no-cache directive

noStore boolean(default false) - Sets the no-store directive

noTransform boolean(default false) - Sets the no-transform directive

isPrivate boolean(default false) - Sets the private and public directives

proxyRevalidate boolean(default false) - Sets the proxy-revalidate directive

maxAge decimal(default -1) - Sets the max-age directive

sMaxAge decimal(default -1) - Sets the s-maxage directive

noCacheFields string[](default []) - Optional fields for the no-cache directive. Before sending a listed field in a response, it must be validated with the origin server.

privateFields string[](default []) - Optional fields for the private directive. A cache can omit the fields specified and store the rest of the response.

http: StatusAccepted

Read Only

Represents the status code of STATUS_ACCEPTED.

Fields

Fields Included from *Status

code int

code STATUS_ACCEPTED(default STATUS_ACCEPTED) - The response status code

http: StatusAlreadyReported

Read Only

Represents the status code of STATUS_ALREADY_REPORTED.

Fields

Fields Included from *Status

code int

code STATUS_ALREADY_REPORTED(default STATUS_ALREADY_REPORTED) - The response status code

http: StatusBadGateway

Read Only

Represents the status code of STATUS_BAD_GATEWAY.

Fields

Fields Included from *Status

code int

code STATUS_BAD_GATEWAY(default STATUS_BAD_GATEWAY) - The response status code

http: StatusBadRequest

Read Only

Represents the status code of STATUS_BAD_REQUEST.

Fields

Fields Included from *Status

code int

code STATUS_BAD_REQUEST(default STATUS_BAD_REQUEST) - The response status code

http: StatusConflict

Read Only

Represents the status code of STATUS_CONFLICT.

Fields

Fields Included from *Status

code int

code STATUS_CONFLICT(default STATUS_CONFLICT) - The response status code

http: StatusContinue

Read Only

Represents the status code of STATUS_CONTINUE.

Fields

Fields Included from *Status

code int

code STATUS_CONTINUE(default STATUS_CONTINUE) - The response status code

http: StatusCreated

Read Only

Represents the status code of STATUS_CREATED.

Fields

Fields Included from *Status

code int

code STATUS_CREATED(default STATUS_CREATED) - The response status code

http: StatusEarlyHints

Read Only

Represents the status code of STATUS_EARLY_HINTS.

Fields

Fields Included from *Status

code int

code STATUS_EARLY_HINTS(default STATUS_EARLY_HINTS) - The response status code

http: StatusExpectationFailed

Read Only

Represents the status code of STATUS_EXPECTATION_FAILED.

Fields

Fields Included from *Status

code int

code STATUS_EXPECTATION_FAILED(default STATUS_EXPECTATION_FAILED) - The response status code

http: StatusFailedDependency

Read Only

Represents the status code of STATUS_FAILED_DEPENDENCY.

Fields

Fields Included from *Status

code int

code STATUS_FAILED_DEPENDENCY(default STATUS_FAILED_DEPENDENCY) - The response status code

http: StatusForbidden

Read Only

Represents the status code of STATUS_FORBIDDEN.

Fields

Fields Included from *Status

code int

code STATUS_FORBIDDEN(default STATUS_FORBIDDEN) - The response status code

http: StatusFound

Read Only

Represents the status code of STATUS_FOUND.

Fields

Fields Included from *Status

code int

code STATUS_FOUND(default STATUS_FOUND) - The response status code

http: StatusGatewayTimeout

Read Only

Represents the status code of STATUS_GATEWAY_TIMEOUT.

Fields

Fields Included from *Status

code int

code STATUS_GATEWAY_TIMEOUT(default STATUS_GATEWAY_TIMEOUT) - The response status code

http: StatusGone

Read Only

Represents the status code of STATUS_GONE.

Fields

Fields Included from *Status

code int

code STATUS_GONE(default STATUS_GONE) - The response status code

http: StatusHttpVersionNotSupported

Read Only

Represents the status code of STATUS_HTTP_VERSION_NOT_SUPPORTED.

Fields

Fields Included from *Status

code int

code STATUS_HTTP_VERSION_NOT_SUPPORTED(default STATUS_HTTP_VERSION_NOT_SUPPORTED) - The response status code

http: StatusIMUsed

Read Only

Represents the status code of STATUS_IM_USED.

Fields

Fields Included from *Status

code int

code STATUS_IM_USED(default STATUS_IM_USED) - The response status code

http: StatusInsufficientStorage

Read Only

Represents the status code of STATUS_INSUFFICIENT_STORAGE.

Fields

Fields Included from *Status

code int

code STATUS_INSUFFICIENT_STORAGE(default STATUS_INSUFFICIENT_STORAGE) - The response status code

http: StatusInternalServerError

Read Only

Represents the status code of STATUS_INTERNAL_SERVER_ERROR.

Fields

Fields Included from *Status

code int

code STATUS_INTERNAL_SERVER_ERROR(default STATUS_INTERNAL_SERVER_ERROR) - The response status code

http: StatusLengthRequired

Read Only

Represents the status code of STATUS_LENGTH_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_LENGTH_REQUIRED(default STATUS_LENGTH_REQUIRED) - The response status code

http: StatusLocked

Read Only

Represents the status code of STATUS_LOCKED.

Fields

Fields Included from *Status

code int

code STATUS_LOCKED(default STATUS_LOCKED) - The response status code

http: StatusLoopDetected

Read Only

Represents the status code of STATUS_LOOP_DETECTED.

Fields

Fields Included from *Status

code int

code STATUS_LOOP_DETECTED(default STATUS_LOOP_DETECTED) - The response status code

http: StatusMethodNotAllowed

Read Only

Represents the status code of STATUS_METHOD_NOT_ALLOWED.

Fields

Fields Included from *Status

code int

code STATUS_METHOD_NOT_ALLOWED(default STATUS_METHOD_NOT_ALLOWED) - The response status code

http: StatusMisdirectedRequest

Read Only

Represents the status code of STATUS_MISDIRECTED_REQUEST.

Fields

Fields Included from *Status

code int

code STATUS_MISDIRECTED_REQUEST(default STATUS_MISDIRECTED_REQUEST) - The response status code

http: StatusMovedPermanently

Read Only

Represents the status code of STATUS_MOVED_PERMANENTLY.

Fields

Fields Included from *Status

code int

code STATUS_MOVED_PERMANENTLY(default STATUS_MOVED_PERMANENTLY) - The response status code

http: StatusMultipleChoices

Read Only

Represents the status code of STATUS_MULTIPLE_CHOICES.

Fields

Fields Included from *Status

code int

code STATUS_MULTIPLE_CHOICES(default STATUS_MULTIPLE_CHOICES) - The response status code

http: StatusMultiStatus

Read Only

Represents the status code of STATUS_MULTI_STATUS.

Fields

Fields Included from *Status

code int

code STATUS_MULTI_STATUS(default STATUS_MULTI_STATUS) - The response status code

http: StatusNetworkAuthenticationRequired

Read Only

Represents the status code of STATUS_NETWORK_AUTHENTICATION_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_NETWORK_AUTHENTICATION_REQUIRED(default STATUS_NETWORK_AUTHENTICATION_REQUIRED) - The response status code

http: StatusNoContent

Read Only

Represents the status code of STATUS_NO_CONTENT.

Fields

Fields Included from *Status

code int

code STATUS_NO_CONTENT(default STATUS_NO_CONTENT) - The response status code

http: StatusNonAuthoritativeInformation

Read Only

Represents the status code of STATUS_NON_AUTHORITATIVE_INFORMATION.

Fields

Fields Included from *Status

code int

code STATUS_NON_AUTHORITATIVE_INFORMATION(default STATUS_NON_AUTHORITATIVE_INFORMATION) - The response status code

http: StatusNotAcceptable

Read Only

Represents the status code of STATUS_NOT_ACCEPTABLE.

Fields

Fields Included from *Status

code int

code STATUS_NOT_ACCEPTABLE(default STATUS_NOT_ACCEPTABLE) - The response status code

http: StatusNotExtended

Read Only

Represents the status code of STATUS_NOT_EXTENDED.

Fields

Fields Included from *Status

code int

code STATUS_NOT_EXTENDED(default STATUS_NOT_EXTENDED) - The response status code

http: StatusNotFound

Read Only

Represents the status code of STATUS_NOT_FOUND.

Fields

Fields Included from *Status

code int

code STATUS_NOT_FOUND(default STATUS_NOT_FOUND) - The response status code

http: StatusNotImplemented

Read Only

Represents the status code of STATUS_NOT_IMPLEMENTED.

Fields

Fields Included from *Status

code int

code STATUS_NOT_IMPLEMENTED(default STATUS_NOT_IMPLEMENTED) - The response status code

http: StatusNotModified

Read Only

Represents the status code of STATUS_NOT_MODIFIED.

Fields

Fields Included from *Status

code int

code STATUS_NOT_MODIFIED(default STATUS_NOT_MODIFIED) - The response status code

http: StatusOK

Read Only

Represents the status code of STATUS_OK.

Fields

Fields Included from *Status

code int

code STATUS_OK(default STATUS_OK) - The response status code

http: StatusPartialContent

Read Only

Represents the status code of STATUS_PARTIAL_CONTENT.

Fields

Fields Included from *Status

code int

code STATUS_PARTIAL_CONTENT(default STATUS_PARTIAL_CONTENT) - The response status code

http: StatusPayloadTooLarge

Read Only

Represents the status code of STATUS_PAYLOAD_TOO_LARGE.

Fields

Fields Included from *Status

code int

code STATUS_PAYLOAD_TOO_LARGE(default STATUS_PAYLOAD_TOO_LARGE) - The response status code

http: StatusPaymentRequired

Read Only

Represents the status code of STATUS_PAYMENT_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_PAYMENT_REQUIRED(default STATUS_PAYMENT_REQUIRED) - The response status code

http: StatusPermanentRedirect

Read Only

Represents the status code of STATUS_PERMANENT_REDIRECT.

Fields

Fields Included from *Status

code int

code STATUS_PERMANENT_REDIRECT(default STATUS_PERMANENT_REDIRECT) - The response status code

http: StatusPreconditionFailed

Read Only

Represents the status code of STATUS_PRECONDITION_FAILED.

Fields

Fields Included from *Status

code int

code STATUS_PRECONDITION_FAILED(default STATUS_PRECONDITION_FAILED) - The response status code

http: StatusPreconditionRequired

Read Only

Represents the status code of STATUS_PRECONDITION_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_PRECONDITION_REQUIRED(default STATUS_PRECONDITION_REQUIRED) - The response status code

http: StatusProcessing

Read Only

Represents the status code of STATUS_PROCESSING.

Fields

Fields Included from *Status

code int

code STATUS_PROCESSING(default STATUS_PROCESSING) - The response status code

http: StatusProxyAuthenticationRequired

Read Only

Represents the status code of STATUS_PROXY_AUTHENTICATION_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_PROXY_AUTHENTICATION_REQUIRED(default STATUS_PROXY_AUTHENTICATION_REQUIRED) - The response status code

http: StatusRangeNotSatisfiable

Read Only

Represents the status code of STATUS_RANGE_NOT_SATISFIABLE.

Fields

Fields Included from *Status

code int

code STATUS_RANGE_NOT_SATISFIABLE(default STATUS_RANGE_NOT_SATISFIABLE) - The response status code

http: StatusRequestHeaderFieldsTooLarge

Read Only

Represents the status code of STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE.

Fields

Fields Included from *Status

code int

code STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE(default STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE) - The response status code

http: StatusRequestTimeout

Read Only

Represents the status code of STATUS_REQUEST_TIMEOUT.

Fields

Fields Included from *Status

code int

code STATUS_REQUEST_TIMEOUT(default STATUS_REQUEST_TIMEOUT) - The response status code

http: StatusResetContent

Read Only

Represents the status code of STATUS_RESET_CONTENT.

Fields

Fields Included from *Status

code int

code STATUS_RESET_CONTENT(default STATUS_RESET_CONTENT) - The response status code

http: StatusSeeOther

Read Only

Represents the status code of STATUS_SEE_OTHER.

Fields

Fields Included from *Status

code int

code STATUS_SEE_OTHER(default STATUS_SEE_OTHER) - The response status code

http: StatusServiceUnavailable

Read Only

Represents the status code of STATUS_SERVICE_UNAVAILABLE.

Fields

Fields Included from *Status

code int

code STATUS_SERVICE_UNAVAILABLE(default STATUS_SERVICE_UNAVAILABLE) - The response status code

http: StatusSwitchingProtocols

Read Only

Represents the status code of STATUS_SWITCHING_PROTOCOLS.

Fields

Fields Included from *Status

code int

code STATUS_SWITCHING_PROTOCOLS(default STATUS_SWITCHING_PROTOCOLS) - The response status code

http: StatusTemporaryRedirect

Read Only

Represents the status code of STATUS_TEMPORARY_REDIRECT.

Fields

Fields Included from *Status

code int

code STATUS_TEMPORARY_REDIRECT(default STATUS_TEMPORARY_REDIRECT) - The response status code

http: StatusTooEarly

Read Only

Represents the status code of STATUS_TOO_EARLY.

Fields

Fields Included from *Status

code int

code STATUS_TOO_EARLY(default STATUS_TOO_EARLY) - The response status code

http: StatusTooManyRequests

Read Only

Represents the status code of STATUS_TOO_MANY_REQUESTS.

Fields

Fields Included from *Status

code int

code STATUS_TOO_MANY_REQUESTS(default STATUS_TOO_MANY_REQUESTS) - The response status code

http: StatusUnauthorized

Read Only

Represents the status code of STATUS_UNAUTHORIZED.

Fields

Fields Included from *Status

code int

code STATUS_UNAUTHORIZED(default STATUS_UNAUTHORIZED) - The response status code

http: StatusUnavailableDueToLegalReasons

Read Only

Represents the status code of STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS.

Fields

Fields Included from *Status

code int

code STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS(default STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS) - The response status code

http: StatusUnprocessableEntity

Read Only

Represents the status code of STATUS_UNPROCESSABLE_ENTITY.

Fields

Fields Included from *Status

code int

code STATUS_UNPROCESSABLE_ENTITY(default STATUS_UNPROCESSABLE_ENTITY) - The response status code

http: StatusUnsupportedMediaType

Read Only

Represents the status code of STATUS_UNSUPPORTED_MEDIA_TYPE.

Fields

Fields Included from *Status

code int

code STATUS_UNSUPPORTED_MEDIA_TYPE(default STATUS_UNSUPPORTED_MEDIA_TYPE) - The response status code

http: StatusUpgradeRequired

Read Only

Represents the status code of STATUS_UPGRADE_REQUIRED.

Fields

Fields Included from *Status

code int

code STATUS_UPGRADE_REQUIRED(default STATUS_UPGRADE_REQUIRED) - The response status code

http: StatusUriTooLong

Read Only

Represents the status code of STATUS_URI_TOO_LONG.

Fields

Fields Included from *Status

code int

code STATUS_URI_TOO_LONG(default STATUS_URI_TOO_LONG) - The response status code

http: StatusUseProxy

Read Only

Represents the status code of STATUS_USE_PROXY.

Fields

Fields Included from *Status

code int

code STATUS_USE_PROXY(default STATUS_USE_PROXY) - The response status code

http: StatusVariantAlsoNegotiates

Read Only

Represents the status code of STATUS_VARIANT_ALSO_NEGOTIATES.

Fields

Fields Included from *Status

code int

code STATUS_VARIANT_ALSO_NEGOTIATES(default STATUS_VARIANT_ALSO_NEGOTIATES) - The response status code

Clients

http: Caller

Isolated

The caller actions for responding to client requests.

respond

Isolated FunctionRemote Function

function respond(ResponseMessage|StatusCodeResponse|error message) returns ListenerError?

Sends the outbound response to the caller.

Parameters

message ResponseMessage|StatusCodeResponse|error (default ()) - The outbound response or status code response or error or any allowed payload

Return Type

ListenerError? - An http:ListenerError if failed to respond or else ()

promise

Isolated FunctionRemote Function

function promise(PushPromise promise) returns ListenerError?

Pushes a promise to the caller.

Parameters

promise PushPromise - Push promise message

Return Type

ListenerError? - An http:ListenerError in case of failures

pushPromisedResponse

Isolated FunctionRemote Function

function pushPromisedResponse(PushPromise promise, Response response) returns ListenerError?

Sends a promised push response to the caller.

Parameters

promise PushPromise - Push promise message

response Response - The outbound response

Return Type

ListenerError? - An http:ListenerError in case of failures while responding with the promised response

'continue

Isolated FunctionRemote Function

function 'continue() returns ListenerError?

Sends a 100-continue response to the caller.

Return Type

ListenerError? - An http:ListenerError if failed to send the 100-continue response or else ()

redirect

Isolated FunctionRemote Function

function redirect(Response response, RedirectCode code, string[] locations) returns ListenerError?

Sends a redirect response to the user with the specified redirection status code.

Parameters

response Response - Response to be sent to the caller

code RedirectCode - The redirect status code to be sent

locations string[] - An array of URLs to which the caller can redirect to

Return Type

ListenerError? - An http:ListenerError if failed to send the redirect response or else ()

getRemoteHostName

Isolated Function

function getRemoteHostName() returns string?

Gets the hostname from the remote address. This method may trigger a DNS reverse lookup if the address was created with a literal IP address.


string? remoteHost = caller.getRemoteHostName();

Return Type

string? - The hostname of the address or else () if it is unresolved

http: Client

Isolated

The HTTP client provides the capability for initiating contact with a remote HTTP service. The API it provides includes the functions for the standard HTTP methods forwarding a received request and sending requests using custom HTTP verbs.

Constructor

Gets invoked to initialize the client. During initialization, the configurations provided through the config record is used to determine which type of additional behaviours are added to the endpoint (e.g., caching, security, circuit breaking).

init (string url, *ClientConfiguration config)

url string - URL of the target service

config *ClientConfiguration - The configurations to be used when initializing the client

post

Isolated FunctionRemote Function

function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The Client.post() function can be used to send HTTP POST requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

Isolated FunctionRemote Function

function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The Client.put() function can be used to send HTTP PUT requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

Isolated FunctionRemote Function

function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The Client.patch() function can be used to send HTTP PATCH requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

Isolated FunctionRemote Function

function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The Client.delete() function can be used to send HTTP DELETE requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage (default ()) - An optional HTTP outbound request message or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head

Isolated FunctionRemote Function

function head(string path, map<string|string[]>? headers) returns Response|ClientError

The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get

Isolated FunctionRemote Function

function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The Client.get() function can be used to send HTTP GET requests to HTTP endpoints.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

Isolated FunctionRemote Function

function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

execute

Isolated FunctionRemote Function

function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

Invokes an HTTP call with the specified HTTP verb.

Parameters

httpVerb string - HTTP verb value

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

forward

Isolated FunctionRemote Function

function forward(string path, Request request, TargetType targetType) returns targetType|ClientError

The Client.forward() function can be used to invoke an HTTP call with inbound request's HTTP verb

Parameters

path string - Request path

request Request - An HTTP inbound request message

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

submit

Isolated FunctionRemote Function

function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientError

Submits an HTTP request to a service with the specified HTTP verb. The Client->submit() function does not give out a http:Response as the result. Rather it returns an http:HttpFuture which can be used to do further interactions with the endpoint.

Parameters

httpVerb string - The HTTP verb value

path string - The resource path

message RequestMessage - An HTTP outbound request or any allowed payload

Return Type

HttpFuture|ClientError - An http:HttpFuture that represents an asynchronous service invocation or else an http:ClientError if the submission fails

getResponse

Isolated FunctionRemote Function

function getResponse(HttpFuture httpFuture) returns Response|ClientError

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

Response|ClientError - An http:Response message or else an http: ClientError if the invocation fails

hasPromise

Isolated FunctionRemote Function

function hasPromise(HttpFuture httpFuture) returns boolean

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture relates to a previous asynchronous invocation

Return Type

boolean - A boolean, which represents whether an http:PushPromise exists

getNextPromise

Isolated FunctionRemote Function

function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientError

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

PushPromise|ClientError - An http:PushPromise message or else an http:ClientError if the invocation fails

getPromisedResponse

Isolated FunctionRemote Function

function getPromisedResponse(PushPromise promise) returns Response|ClientError

Passes the request to an actual network call.

Parameters

promise PushPromise - The related http:PushPromise

Return Type

Response|ClientError - A promised http:Response message or else an http:ClientError if the invocation fails

rejectPromise

Isolated FunctionRemote Function

function rejectPromise(PushPromise promise)

This just pass the request to actual network call.

Parameters

promise PushPromise - The Push Promise to be rejected

post [PathParamType ...path]

Isolated FunctionResource Function

function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP POST requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put [PathParamType ...path]

Isolated FunctionResource Function

function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PUT requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch [PathParamType ...path]

Isolated FunctionResource Function

function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PATCH requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete [PathParamType ...path]

Isolated FunctionResource Function

function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP DELETE requests to HTTP endpoints.

Parameters

message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head [PathParamType ...path]

Isolated FunctionResource Function

function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientError

The client resource function to send HTTP HEAD requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

params *QueryParams - The query parameters

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get [PathParamType ...path]

Isolated FunctionResource Function

function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP GET requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options [PathParamType ...path]

Isolated FunctionResource Function

function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP OPTIONS requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

getCookieStore

Isolated Function

function getCookieStore() returns CookieStore?

Retrieves the cookie store of the client.

Return Type

CookieStore? - The cookie store related to the client

circuitBreakerForceClose

Isolated Function

function circuitBreakerForceClose()

The circuit breaker client related method to force the circuit into a closed state in which it will allow requests regardless of the error percentage until the failure threshold exceeds.

circuitBreakerForceOpen

Isolated Function

function circuitBreakerForceOpen()

The circuit breaker client related method to force the circuit into a open state in which it will suspend all requests until resetTime interval exceeds.

getCircuitBreakerCurrentState

Isolated Function

function getCircuitBreakerCurrentState() returns CircuitState

The circuit breaker client related method to provides the http:CircuitState of the circuit breaker.

Return Type

CircuitState - The current http:CircuitState of the circuit breaker

http: ClientOAuth2Handler

Isolated

Defines the OAuth2 handler for client authentication.

Constructor

Initializes the http:ClientOAuth2Handler object.

init (OAuth2GrantConfig config)

config OAuth2GrantConfig - The http:OAuth2GrantConfig instance

enrich

Isolated FunctionRemote Function

function enrich(Request req) returns Request|ClientAuthError

Enrich the request with the relevant authentication requirements.

Parameters

req Request - The http:Request instance

Return Type

Request|ClientAuthError - The updated http:Request instance or else an http:ClientAuthError in case of an error

enrichHeaders

Isolated Function

function enrichHeaders(map<string|string[]> headers) returns map<string|string[]>|ClientAuthError

Enrich the headers map with the relevant authentication requirements.

Parameters

headers map<string|string[]> - The headers map

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

getSecurityHeaders

Isolated Function

function getSecurityHeaders() returns map<string|string[]>|ClientAuthError

Returns the headers map with the relevant authentication requirements.

Return Type

map<string|string[]>|ClientAuthError - The updated headers map or else an http:ClientAuthError in case of an error

http: FailoverClient

Isolated

An HTTP client endpoint which provides failover support over multiple HTTP clients.

Constructor

Failover caller actions which provides failover capabilities to an HTTP client endpoint.

init (*FailoverClientConfiguration failoverClientConfig)

failoverClientConfig *FailoverClientConfiguration - The configurations of the client endpoint associated with this Failover instance

post

Isolated FunctionRemote Function

function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The POST remote function implementation of the Failover Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

Isolated FunctionRemote Function

function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The PUT remote function implementation of the Failover Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

Isolated FunctionRemote Function

function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The PATCH remote function implementation of the Failover Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

Isolated FunctionRemote Function

function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The DELETE remote function implementation of the Failover Connector.

Parameters

path string - Resource path

message RequestMessage (default ()) - An optional HTTP outbound request message or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head

Isolated FunctionRemote Function

function head(string path, map<string|string[]>? headers) returns Response|ClientError

The HEAD remote function implementation of the Failover Connector.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get

Isolated FunctionRemote Function

function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The GET remote function implementation of the Failover Connector.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

Isolated FunctionRemote Function

function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The OPTIONS remote function implementation of the Failover Connector.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

execute

Isolated FunctionRemote Function

function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

Invokes an HTTP call with the specified HTTP method.

Parameters

httpVerb string - HTTP verb value

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

forward

Isolated FunctionRemote Function

function forward(string path, Request request, TargetType targetType) returns targetType|ClientError

Invokes an HTTP call using the incoming request's HTTP method.

Parameters

path string - Resource path

request Request - An HTTP request

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

submit

Isolated FunctionRemote Function

function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientError

Submits an HTTP request to a service with the specified HTTP verb. The FailoverClient.submit() function does not return an http:Response as the result. Rather it returns an http:HttpFuture which can be used for subsequent interactions with the HTTP endpoint.

Parameters

httpVerb string - The HTTP verb value

path string - The resource path

message RequestMessage - An HTTP outbound request or any allowed payload

Return Type

HttpFuture|ClientError - An http:HttpFuture that represents an asynchronous service invocation or else an http:ClientError if the submission fails

getResponse

Isolated FunctionRemote Function

function getResponse(HttpFuture httpFuture) returns Response|ClientError

Retrieves the http:Response for a previously-submitted request.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

Response|ClientError - An http:Response message or else an http:ClientError if the invocation fails

hasPromise

Isolated FunctionRemote Function

function hasPromise(HttpFuture httpFuture) returns boolean

Checks whether an http:PushPromise exists for a previously-submitted request.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

boolean - A boolean, which represents whether an http:PushPromise exists

getNextPromise

Isolated FunctionRemote Function

function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientError

Retrieves the next available http:PushPromise for a previously-submitted request.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

PushPromise|ClientError - An http:PushPromise message or else an http:ClientError if the invocation fails

getPromisedResponse

Isolated FunctionRemote Function

function getPromisedResponse(PushPromise promise) returns Response|ClientError

Retrieves the promised server push http:Response message.

Parameters

promise PushPromise - The related http:PushPromise

Return Type

Response|ClientError - A promised http:Response message or else an http:ClientError if the invocation fails

rejectPromise

Isolated FunctionRemote Function

function rejectPromise(PushPromise promise)

Rejects an http:PushPromise. When an http:PushPromise is rejected, there is no chance of fetching a promised response using the rejected promise.

Parameters

promise PushPromise - The Push Promise to be rejected

post [PathParamType ...path]

Isolated FunctionResource Function

function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The POST resource function implementation of the Failover Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put [PathParamType ...path]

Isolated FunctionResource Function

function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The PUT resource function implementation of the Failover Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch [PathParamType ...path]

Isolated FunctionResource Function

function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The PATCH resource function implementation of the Failover Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete [PathParamType ...path]

Isolated FunctionResource Function

function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The DELETE resource function implementation of the Failover Connector.

Parameters

message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head [PathParamType ...path]

Isolated FunctionResource Function

function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientError

The HEAD resource function implementation of the Failover Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

params *QueryParams - The query parameters

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get [PathParamType ...path]

Isolated FunctionResource Function

function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The GET resource function implementation of the Failover Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options [PathParamType ...path]

Isolated FunctionResource Function

function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The OPTIONS resource function implementation of the Failover Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

getSucceededEndpointIndex

Isolated Function

function getSucceededEndpointIndex() returns int

Gets the index of the TargetService[] array which given a successful response.

Return Type

int - The successful target endpoint index

http: ListenerLdapUserStoreBasicAuthHandler

Isolated

Defines the LDAP store Basic Auth handler for listener authentication.

Constructor

Initializes the http:ListenerLdapUserStoreBasicAuthProvider object.

init (LdapUserStoreConfig config)

config LdapUserStoreConfig - The http:LdapUserStoreConfig instance

authenticate

Isolated FunctionRemote Function

function authenticate(Request|Headers|string data) returns UserDetails|Unauthorized

Authenticates with the relevant authentication requirements.

Parameters

data Request|Headers|string - The http:Request instance or http:Headers instance or string Authorization header

Return Type

UserDetails|Unauthorized - The auth:UserDetails instance or else Unauthorized type in case of an error

authorize

Isolated FunctionRemote Function

function authorize(UserDetails userDetails, string|string[] expectedScopes) returns Forbidden?

Authorizes with the relevant authorization requirements.

Parameters

userDetails UserDetails - The auth:UserDetails instance which is received from authentication results

expectedScopes string|string[] - The expected scopes as string or string[]

Return Type

Forbidden? - (), if it is successful or else Forbidden type in case of an error

http: ListenerOAuth2Handler

Isolated

Defines the OAuth2 handler for listener authentication.

Constructor

Initializes the http:ListenerOAuth2Handler object.

init (OAuth2IntrospectionConfig config)

config OAuth2IntrospectionConfig - The http:OAuth2IntrospectionConfig instance

authorize

Isolated FunctionRemote Function

function authorize(Request|Headers|string data, string|string[]? expectedScopes, map<string>? optionalParams) returns IntrospectionResponse|Unauthorized|Forbidden

Authorizes with the relevant authentication & authorization requirements.

Parameters

data Request|Headers|string - The http:Request instance or http:Headers instance or string Authorization header

expectedScopes string|string[]? (default ()) - The expected scopes as string or string[]

optionalParams map<string>? (default ()) - Map of optional parameters that need to be sent to introspection endpoint

Return Type

IntrospectionResponse|Unauthorized|Forbidden - The oauth2:IntrospectionResponse instance or else Unauthorized or Forbidden type in case of an error

http: LoadBalanceClient

Isolated

LoadBalanceClient endpoint provides load balancing functionality over multiple HTTP clients.

Constructor

Load Balancer adds an additional layer to the HTTP client to make network interactions more resilient.

init (*LoadBalanceClientConfiguration loadBalanceClientConfig)

loadBalanceClientConfig *LoadBalanceClientConfiguration - The configurations for the load balance client endpoint

post

Isolated FunctionRemote Function

function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The POST remote function implementation of the LoadBalancer Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

Isolated FunctionRemote Function

function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The PUT remote function implementation of the Load Balance Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

Isolated FunctionRemote Function

function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The PATCH remote function implementation of the LoadBalancer Connector.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

Isolated FunctionRemote Function

function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The DELETE remote function implementation of the LoadBalancer Connector.

Parameters

path string - Resource path

message RequestMessage (default ()) - An optional HTTP outbound request message or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head

Isolated FunctionRemote Function

function head(string path, map<string|string[]>? headers) returns Response|ClientError

The HEAD remote function implementation of the LoadBalancer Connector.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get

Isolated FunctionRemote Function

function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The GET remote function implementation of the LoadBalancer Connector.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

Isolated FunctionRemote Function

function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientError

The OPTIONS remote function implementation of the LoadBalancer Connector.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

execute

Isolated FunctionRemote Function

function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientError

The EXECUTE remote function implementation of the LoadBalancer Connector.

Parameters

httpVerb string - HTTP verb value

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

forward

Isolated FunctionRemote Function

function forward(string path, Request request, TargetType targetType) returns targetType|ClientError

The FORWARD remote function implementation of the LoadBalancer Connector.

Parameters

path string - Resource path

request Request - An HTTP request

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

submit

Isolated FunctionRemote Function

function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientError

The submit implementation of the LoadBalancer Connector.

Parameters

httpVerb string - The HTTP verb value

path string - The resource path

message RequestMessage - An HTTP outbound request or any allowed payload

Return Type

HttpFuture|ClientError - An http:HttpFuture that represents an asynchronous service invocation or else an http:ClientError if the submission fails

getResponse

Isolated FunctionRemote Function

function getResponse(HttpFuture httpFuture) returns Response|ClientError

The getResponse implementation of the LoadBalancer Connector.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

Response|ClientError - An http:Response message or else an http:ClientError if the invocation fails

hasPromise

Isolated FunctionRemote Function

function hasPromise(HttpFuture httpFuture) returns boolean

The hasPromise implementation of the LoadBalancer Connector.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

boolean - A boolean, which represents whether an http:PushPromise exists

getNextPromise

Isolated FunctionRemote Function

function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientError

The getNextPromise implementation of the LoadBalancer Connector.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

PushPromise|ClientError - An http:PushPromise message or else an http:ClientError if the invocation fails

getPromisedResponse

Isolated FunctionRemote Function

function getPromisedResponse(PushPromise promise) returns Response|ClientError

The getPromisedResponse implementation of the LoadBalancer Connector.

Parameters

promise PushPromise - The related http:PushPromise

Return Type

Response|ClientError - A promised http:Response message or else an http:ClientError if the invocation fails

rejectPromise

Isolated FunctionRemote Function

function rejectPromise(PushPromise promise)

The rejectPromise implementation of the LoadBalancer Connector.

Parameters

promise PushPromise - The Push Promise to be rejected

post [PathParamType ...path]

Isolated FunctionResource Function

function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The POST resource function implementation of the LoadBalancer Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put [PathParamType ...path]

Isolated FunctionResource Function

function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The PUT resource function implementation of the LoadBalancer Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch [PathParamType ...path]

Isolated FunctionResource Function

function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The PATCH resource function implementation of the LoadBalancer Connector.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete [PathParamType ...path]

Isolated FunctionResource Function

function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientError

The DELETE resource function implementation of the LoadBalancer Connector.

Parameters

message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head [PathParamType ...path]

Isolated FunctionResource Function

function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientError

The HEAD resource function implementation of the LoadBalancer Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

params *QueryParams - The query parameters

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get [PathParamType ...path]

Isolated FunctionResource Function

function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The GET resource function implementation of the LoadBalancer Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options [PathParamType ...path]

Isolated FunctionResource Function

function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientError

The OPTIONS resource function implementation of the LoadBalancer Connector.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType TargetType (default <>) - HTTP response, anydata or stream of HTTP SSE, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

http: StatusCodeClient

Isolated

The HTTP status code client provides the capability for initiating contact with a remote HTTP service. The API it provides includes the functions for the standard HTTP methods forwarding a received request and sending requests using custom HTTP verbs. The responses can be binded to http:StatusCodeResponse types

Constructor

init (string url, *ClientConfiguration config)

url string - URL of the target service

config *ClientConfiguration - The configurations to be used when initializing the client

post

Isolated FunctionRemote Function

function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.post() function can be used to send HTTP POST requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

Isolated FunctionRemote Function

function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.put() function can be used to send HTTP PUT requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

Isolated FunctionRemote Function

function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.patch() function can be used to send HTTP PATCH requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

Isolated FunctionRemote Function

function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.delete() function can be used to send HTTP DELETE requests to HTTP endpoints.

Parameters

path string - Resource path

message RequestMessage (default ()) - An optional HTTP outbound request message or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head

Isolated FunctionRemote Function

function head(string path, map<string|string[]>? headers) returns Response|ClientError

The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.

Parameters

path string - Resource path

headers map<string|string[]>? (default ()) - The entity headers

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get

Isolated FunctionRemote Function

function get(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.get() function can be used to send HTTP GET requests to HTTP endpoints.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

Isolated FunctionRemote Function

function options(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.

Parameters

path string - Request path

headers map<string|string[]>? (default ()) - The entity headers

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

execute

Isolated FunctionRemote Function

function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

Invokes an HTTP call with the specified HTTP verb.

Parameters

httpVerb string - HTTP verb value

path string - Resource path

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

forward

Isolated FunctionRemote Function

function forward(string path, Request request, typedesc<StatusCodeResponse> targetType) returns targetType|ClientError

The Client.forward() function can be used to invoke an HTTP call with inbound request's HTTP verb

Parameters

path string - Request path

request Request - An HTTP inbound request message

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

submit

Isolated FunctionRemote Function

function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientError

Parameters

httpVerb string - The HTTP verb value

path string - The resource path

message RequestMessage - An HTTP outbound request or any allowed payload

Return Type

HttpFuture|ClientError - An http:HttpFuture that represents an asynchronous service invocation or else an http:ClientError if the submission fails

getResponse

Isolated FunctionRemote Function

function getResponse(HttpFuture httpFuture) returns Response|ClientError

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

Response|ClientError - An http:Response message or else an http: ClientError if the invocation fails

hasPromise

Isolated FunctionRemote Function

function hasPromise(HttpFuture httpFuture) returns boolean

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture relates to a previous asynchronous invocation

Return Type

boolean - A boolean, which represents whether an http:PushPromise exists

getNextPromise

Isolated FunctionRemote Function

function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientError

This just pass the request to actual network call.

Parameters

httpFuture HttpFuture - The http:HttpFuture related to a previous asynchronous invocation

Return Type

PushPromise|ClientError - An http:PushPromise message or else an http:ClientError if the invocation fails

getPromisedResponse

Isolated FunctionRemote Function

function getPromisedResponse(PushPromise promise) returns Response|ClientError

Passes the request to an actual network call.

Parameters

promise PushPromise - The related http:PushPromise

Return Type

Response|ClientError - A promised http:Response message or else an http:ClientError if the invocation fails

rejectPromise

Isolated FunctionRemote Function

function rejectPromise(PushPromise promise)

This just pass the request to actual network call.

Parameters

promise PushPromise - The Push Promise to be rejected

post [PathParamType ...path]

Isolated FunctionResource Function

function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP POST requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put [PathParamType ...path]

Isolated FunctionResource Function

function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PUT requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch [PathParamType ...path]

Isolated FunctionResource Function

function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PATCH requests to HTTP endpoints.

Parameters

message RequestMessage - An HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete [PathParamType ...path]

Isolated FunctionResource Function

function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP DELETE requests to HTTP endpoints.

Parameters

message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload

headers map<string|string[]>? (default ()) - The entity headers

mediaType string? (default ()) - The MIME type header of the request entity

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

head [PathParamType ...path]

Isolated FunctionResource Function

function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientError

The client resource function to send HTTP HEAD requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

params *QueryParams - The query parameters

Return Type

Response|ClientError - The response or an http:ClientError if failed to establish the communication with the upstream server

get [PathParamType ...path]

Isolated FunctionResource Function

function get [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP GET requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options [PathParamType ...path]

Isolated FunctionResource Function

function options [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP OPTIONS requests to HTTP endpoints.

Parameters

headers map<string|string[]>? (default ()) - The entity headers

targetType typedesc<StatusCodeResponse> (default <>) - HTTP status code response, which is expected to be returned after data binding

params *QueryParams - The query parameters

Return Type

targetType|ClientError - The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

getCookieStore

Isolated Function

function getCookieStore() returns CookieStore?

Retrieves the cookie store of the client.

Return Type

CookieStore? - The cookie store related to the client

circuitBreakerForceClose

Isolated Function

function circuitBreakerForceClose()

The circuit breaker client related method to force the circuit into a closed state in which it will allow requests regardless of the error percentage until the failure threshold exceeds.

circuitBreakerForceOpen

Isolated Function

function circuitBreakerForceOpen()

The circuit breaker client related method to force the circuit into a open state in which it will suspend all requests until resetTime interval exceeds.

getCircuitBreakerCurrentState

Isolated Function

function getCircuitBreakerCurrentState() returns CircuitState

The circuit breaker client related method to provides the http:CircuitState of the circuit breaker.

Return Type

CircuitState - The current http:CircuitState of the circuit breaker

Service types

http: Service

Distinct

The HTTP service type.

http: ServiceContract

Distinct

The HTTP service contract type.

http: RequestInterceptor

Distinct

The HTTP request interceptor service object type

http: ResponseInterceptor

Distinct

The HTTP response interceptor service object type

http: RequestErrorInterceptor

Distinct

The HTTP request error interceptor service object type

http: ResponseErrorInterceptor

Distinct

The HTTP response error interceptor service object type

http: InterceptableService

Distinct

The service type to be used when engaging interceptors at the service level

createInterceptors

function createInterceptors() returns Interceptor|Interceptor[]

Function to define interceptor pipeline

Return Type

Interceptor|Interceptor[] - The http:Interceptor|http:Interceptor[]

Constants

http: AGE

string "age"

HTTP header key age. Gives the current age of a cached HTTP response.

http: AUTH_HEADER

string "Authorization"

Represents the Authorization header name.

http: AUTH_SCHEME_BASIC

string "Basic"

The prefix used to denote the Basic authentication scheme.

http: AUTH_SCHEME_BEARER

string "Bearer"

The prefix used to denote the Bearer authentication scheme.

http: AUTHORIZATION

string "authorization"

HTTP header key authorization

http: CACHE_CONTROL

string "cache-control"

HTTP header key cache-control. Specifies the cache control directives required for the function of HTTP caches.

http: CACHE_CONTROL_AND_VALIDATORS

string "CACHE_CONTROL_AND_VALIDATORS"

This is a more restricted mode of RFC 7234. Setting this as the caching policy restricts caching to instances where the cache-control header and either the etag or last-modified header are present.

http: CB_CLOSED_STATE

string "CLOSED"

Represents the closed state of the circuit. When the Circuit Breaker is in CLOSED state, all requests will be allowed to go through to the upstream service. If the failures exceed the configured threhold values, the circuit will trip and move to the OPEN state.

http: CB_HALF_OPEN_STATE

string "HALF_OPEN"

Represents the half-open state of the circuit. When the Circuit Breaker is in HALF_OPEN state, a trial request will be sent to the upstream service. If it fails, the circuit will trip again and move to the OPEN state. If not, it will move to the CLOSED state.

http: CB_OPEN_STATE

string "OPEN"

Represents the open state of the circuit. When the Circuit Breaker is in OPEN state, requests will fail immediately.

http: CHUNKING_ALWAYS

string "ALWAYS"

Always set chunking header in the response.

http: CHUNKING_AUTO

string "AUTO"

If the payload is less than 8KB, content-length header is set in the outbound request/response, otherwise chunking header is set in the outbound request/response.}

http: CHUNKING_NEVER

string "NEVER"

Never set the chunking header even if the payload is larger than 8KB in the outbound request/response.

http: COMPRESSION_ALWAYS

string "ALWAYS"

Always set accept-encoding/content-encoding in outbound request/response.

http: COMPRESSION_AUTO

string "AUTO"

When service behaves as a HTTP gateway inbound request/response accept-encoding option is set as the outbound request/response accept-encoding/content-encoding option.

http: COMPRESSION_NEVER

string "NEVER"

Never set accept-encoding/content-encoding header in outbound request/response.

http: CONNECTION

string "connection"

HTTP header key connection. Allows the sender to specify options that are desired for that particular connection.

http: CONTENT_LENGTH

string "content-length"

HTTP header key content-length. Specifies the size of the response body in bytes.

http: CONTENT_TYPE

string "content-type"

HTTP header key content-type. Specifies the type of the message payload.

http: DATE

string "date"

HTTP header key date. The timestamp at the time the response was generated/received.

http: DEFAULT_GRACEFULSTOP_TIMEOUT

decimal 0

Constant for the default listener gracefulStop timeout in seconds

http: DEFAULT_LISTENER_TIMEOUT

decimal 60

Constant for the default listener endpoint timeout in seconds

http: ETAG

string "etag"

HTTP header key etag. A finger print for a resource which is used by HTTP caches to identify whether a resource representation has changed.

http: EXPECT

string "expect"

HTTP header key expect. Specifies expectations to be fulfilled by the server.

http: EXPIRES

string "expires"

HTTP header key expires. Specifies the time at which the response becomes stale.

http: FAILED

string "failed"

Mutual SSL handshake has failed.

http: HTTP_DELETE

string "DELETE"

Constant for the HTTP DELETE method

http: HTTP_FORWARD

string "FORWARD"

Constant for the HTTP FORWARD method

http: HTTP_GET

string "GET"

Constant for the HTTP GET method

http: HTTP_HEAD

string "HEAD"

Constant for the HTTP HEAD method

http: HTTP_NONE

string "NONE"

Constant for the identify not an HTTP Operation

http: HTTP_OPTIONS

string "OPTIONS"

Constant for the HTTP OPTIONS method

http: HTTP_PATCH

string "PATCH"

Constant for the HTTP PATCH method

http: HTTP_POST

string "POST"

Constant for the HTTP POST method

http: HTTP_PUT

string "PUT"

Constant for the HTTP PUT method

http: HTTP_SUBMIT

string "SUBMIT"

constant for the HTTP SUBMIT method

http: IF_MATCH

string "if-match"

HTTP header key if-match

http: IF_MODIFIED_SINCE

string "if-modified-since"

HTTP header key if-modified-since. Used when validating (with the origin server) whether a cached response is still valid. If the representation of the resource has modified since the timestamp in this field, a 304 response is returned.

http: IF_NONE_MATCH

string "if-none-match"

HTTP header key if-none-match. Used when validating (with the origin server) whether a cached response is still valid. If the ETag provided in this field matches the representation of the requested resource, a 304 response is returned.

http: IF_RANGE

string "if-range"

HTTP header key if-range

http: IF_UNMODIFIED_SINCE

string "if-unmodified-since"

HTTP header key if-unmodified-since

http: JWT_INFORMATION

string "JWT_INFORMATION"

Constant to get the jwt information from the request context.

http: KEEPALIVE_ALWAYS

string "ALWAYS"

Keeps the connection alive irrespective of the connection header value }

http: KEEPALIVE_AUTO

string "AUTO"

Decides to keep the connection alive or not based on the connection header of the client request }

http: KEEPALIVE_NEVER

string "NEVER"

Closes the connection irrespective of the connection header value }

http: LAST_MODIFIED

string "last-modified"

HTTP header key last-modified. The time at which the resource was last modified.

http: LEADING

string "leading"

Header is placed before the payload of the request/response.

http: LOCATION

string "location"

HTTP header key location. Indicates the URL to redirect a request to.

http: MAX_AGE

string "max-age"

When used in requests, max-age implies that clients are not willing to accept responses whose age is greater than max-age. When used in responses, the response is to be considered stale after the specified number of seconds.

http: MAX_STALE

string "max-stale"

Indicates that the client is willing to accept responses which have exceeded their freshness lifetime by no more than the specified number of seconds.

http: MAX_STALE_ANY_AGE

decimal 9223372036854775807

Setting this as the max-stale directives indicates that the max-stale directive does not specify a limit.

http: MIN_FRESH

string "min-fresh"

Indicates that the client is only accepting responses whose freshness lifetime >= current age + min-fresh.

http: MULTIPART_AS_PRIMARY_TYPE

string "multipart/"

Represents multipart primary type

http: MUST_REVALIDATE

string "must-revalidate"

Indicates that once the response has become stale, it should not be reused for subsequent requests without validating with the origin server.

http: NO_CACHE

string "no-cache"

Forces the cache to validate a cached response with the origin server before serving.

http: NO_STORE

string "no-store"

Instructs the cache to not store a response in non-volatile storage.

http: NO_TRANSFORM

string "no-transform"

Instructs intermediaries not to transform the payload.

http: NONE

()

Not a mutual ssl connection.

http: ONLY_IF_CACHED

string "only-if-cached"

Indicates that the client is only willing to accept a cached response. A cached response is served subject to other constraints posed by the request.

http: PASSED

string "passed"

Mutual SSL handshake is successful.

http: PRAGMA

string "pragma"

HTTP header key pragma. Used in dealing with HTTP 1.0 caches which do not understand the cache-control header.

http: PRIVATE

string "private"

Indicates that the response is intended for a single user and should not be stored by shared caches.

http: PROXY_AUTHORIZATION

string "proxy-authorization"

HTTP header key proxy-authorization. Contains the credentials to authenticate a user agent to a proxy serve.

http: PROXY_REVALIDATE

string "proxy-revalidate"

Has the same semantics as must-revalidate, except that this does not apply to private caches.

http: PUBLIC

string "public"

Indicates that any cache may store the response.

http: REDIRECT_FOUND_302

int 302

Represents the HTTP redirect status code 302 - Found.

http: REDIRECT_MOVED_PERMANENTLY_301

int 301

Represents the HTTP redirect status code 301 - Moved Permanently.

http: REDIRECT_MULTIPLE_CHOICES_300

int 300

Represents the HTTP redirect status code 300 - Multiple Choices.

http: REDIRECT_NOT_MODIFIED_304

int 304

Represents the HTTP redirect status code 304 - Not Modified.

http: REDIRECT_PERMANENT_REDIRECT_308

int 308

Represents the HTTP redirect status code 308 - Permanent Redirect.

http: REDIRECT_SEE_OTHER_303

int 303

Represents the HTTP redirect status code 303 - See Other.

http: REDIRECT_TEMPORARY_REDIRECT_307

int 307

Represents the HTTP redirect status code 307 - Temporary Redirect.

http: REDIRECT_USE_PROXY_305

int 305

Represents the HTTP redirect status code 305 - Use Proxy.

http: REQUEST_METHOD

string "REQUEST_METHOD"

Constant for the request method reference.

http: RESOURCE_NAME

string "RESOURCE_NAME"

Constant for the resource name reference.

http: RFC_7234

string "RFC_7234"

Caching behaviour is as specified by the RFC 7234 specification.

http: S_MAX_AGE

string "s-maxage"

In shared caches, s-maxage overrides the max-age or expires header field.

http: SERVER

string "server"

HTTP header key server. Specifies the details of the origin server.

http: SERVICE_NAME

string "SERVICE_NAME"

Constant for the service name reference.

http: STATUS_ACCEPTED

int 202

The HTTP response status code: 202 Accepted

http: STATUS_ALREADY_REPORTED

int 208

The HTTP response status code: 208 Already Reported

http: STATUS_BAD_GATEWAY

int 502

The HTTP response status code: 502 Bad Gateway

http: STATUS_BAD_REQUEST

int 400

The HTTP response status code: 400 Bad Request

http: STATUS_CONFLICT

int 409

The HTTP response status code: 409 Conflict

http: STATUS_CONTINUE

int 100

The HTTP response status code: 100 Continue

http: STATUS_CREATED

int 201

The HTTP response status code: 201 Created

http: STATUS_EARLY_HINTS

int 103

The HTTP response status code: 103 Early Hints

http: STATUS_EXPECTATION_FAILED

int 417

The HTTP response status code: 417 Expectation Failed

http: STATUS_FAILED_DEPENDENCY

int 424

The HTTP response status code: 424 Failed Dependency

http: STATUS_FORBIDDEN

int 403

The HTTP response status code: 403 Forbidden

http: STATUS_FOUND

int 302

The HTTP response status code: 302 Found

http: STATUS_GATEWAY_TIMEOUT

int 504

The HTTP response status code: 504 Gateway Timeout

http: STATUS_GONE

int 410

The HTTP response status code: 410 Gone

http: STATUS_HTTP_VERSION_NOT_SUPPORTED

int 505

The HTTP response status code: 505 HTTP Version Not Supported

http: STATUS_IM_USED

int 226

The HTTP response status code: 226 IM Used

http: STATUS_INSUFFICIENT_STORAGE

int 507

The HTTP response status code: 507 Insufficient Storage

http: STATUS_INTERNAL_SERVER_ERROR

int 500

The HTTP response status code: 500 Internal Server Error

http: STATUS_LENGTH_REQUIRED

int 411

The HTTP response status code: 411 Length Required

http: STATUS_LOCKED

int 423

The HTTP response status code: 423 Locked

http: STATUS_LOOP_DETECTED

int 508

The HTTP response status code: 508 Loop Detected

http: STATUS_METHOD_NOT_ALLOWED

int 405

The HTTP response status code: 405 Method Not Allowed

http: STATUS_MISDIRECTED_REQUEST

int 421

The HTTP response status code: 421 Misdirected Request

http: STATUS_MOVED_PERMANENTLY

int 301

The HTTP response status code: 301 Moved Permanently

http: STATUS_MULTI_STATUS

int 207

The HTTP response status code: 207 Multi-Status

http: STATUS_MULTIPLE_CHOICES

int 300

The HTTP response status code: 300 Multiple Choices

http: STATUS_NETWORK_AUTHENTICATION_REQUIRED

int 511

The HTTP response status code: 511 Network Authorization Required

http: STATUS_NO_CONTENT

int 204

The HTTP response status code: 204 No Content

http: STATUS_NON_AUTHORITATIVE_INFORMATION

int 203

The HTTP response status code: 203 Non Authoritative Information

http: STATUS_NOT_ACCEPTABLE

int 406

The HTTP response status code: 406 Not Acceptable

http: STATUS_NOT_EXTENDED

int 510

The HTTP response status code: 510 Not Extended

http: STATUS_NOT_FOUND

int 404

The HTTP response status code: 404 Not Found

http: STATUS_NOT_IMPLEMENTED

int 501

The HTTP response status code: 501 Not Implemented

http: STATUS_NOT_MODIFIED

int 304

The HTTP response status code: 304 Not Modified

http: STATUS_OK

int 200

The HTTP response status code: 200 OK

http: STATUS_PARTIAL_CONTENT

int 206

The HTTP response status code: 206 Partial Content

http: STATUS_PAYLOAD_TOO_LARGE

int 413

The HTTP response status code: 413 Payload Too Large

http: STATUS_PAYMENT_REQUIRED

int 402

The HTTP response status code: 402 Payment Required

http: STATUS_PERMANENT_REDIRECT

int 308

The HTTP response status code: 308 Permanent Redirect

http: STATUS_PRECONDITION_FAILED

int 412

The HTTP response status code: 412 Precondition Failed

http: STATUS_PRECONDITION_REQUIRED

int 428

The HTTP response status code: 428 Precondition Required

http: STATUS_PROCESSING

int 102

The HTTP response status code: 102 Processing

http: STATUS_PROXY_AUTHENTICATION_REQUIRED

int 407

The HTTP response status code: 407 Proxy Authentication Required

http: STATUS_RANGE_NOT_SATISFIABLE

int 416

The HTTP response status code: 416 Range Not Satisfiable

http: STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE

int 431

The HTTP response status code: 431 Request Header Fields Too Large

http: STATUS_REQUEST_TIMEOUT

int 408

The HTTP response status code: 408 Request Timeout

http: STATUS_RESET_CONTENT

int 205

The HTTP response status code: 205 Reset Content

http: STATUS_SEE_OTHER

int 303

The HTTP response status code: 303 See Other

http: STATUS_SERVICE_UNAVAILABLE

int 503

The HTTP response status code: 503 Service Unavailable

http: STATUS_SWITCHING_PROTOCOLS

int 101

The HTTP response status code: 101 Switching Protocols

http: STATUS_TEMPORARY_REDIRECT

int 307

The HTTP response status code: 307 Temporary Redirect

http: STATUS_TOO_EARLY

int 425

The HTTP response status code: 425 Too Early

http: STATUS_TOO_MANY_REQUESTS

int 429

The HTTP response status code: 429 Too Many Requests

http: STATUS_UNAUTHORIZED

int 401

The HTTP response status code: 401 Unauthorized

http: STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS

int 451

The HTTP response status code: 451 Unavailable Due To Legal Reasons

http: STATUS_UNPROCESSABLE_ENTITY

int 422

The HTTP response status code: 422 Unprocessable Entity

http: STATUS_UNSUPPORTED_MEDIA_TYPE

int 415

The HTTP response status code: 415 Unsupported Media Type

http: STATUS_UPGRADE_REQUIRED

int 426

The HTTP response status code: 426 Upgrade Required

http: STATUS_URI_TOO_LONG

int 414

The HTTP response status code: 414 URI Too Long

http: STATUS_USE_PROXY

int 305

The HTTP response status code: 305 Use Proxy

http: STATUS_VARIANT_ALSO_NEGOTIATES

int 506

The HTTP response status code: 506 Variant Also Negotiates

http: TRAILING

string "trailing"

Header is placed after the payload of the request/response.

http: TRANSFER_ENCODING

string "transfer-encoding"

HTTP header key transfer-encoding. Specifies what type of transformation has been applied to entity body.

http: UPGRADE

string "upgrade"

HTTP header key upgrade. Allows the client to specify what additional communication protocols it supports and would like to use, if the server finds it appropriate to switch protocols.

http: WARNING

string "warning"

HTTP header key warning. Specifies warnings generated when serving stale responses from HTTP caches.

Enums

http: CertValidationType

Represents certification validation type options.

Members

OCSP_CRL

OCSP_STAPLING

http: HttpVersion

Defines the supported HTTP protocols.

Members

HTTP_1_0 - Represents HTTP/1.0 protocol

HTTP_1_1 - Represents HTTP/1.1 protocol

HTTP_2_0 - Represents HTTP/2.0 protocol

http: Method

Represents HTTP methods.

Members

GET

POST

PUT

DELETE

PATCH

HEAD

OPTIONS

http: Protocol

Represents protocol options.

Members

SSL

TLS

DTLS

http: VerifyClient

Represents client verify options.

Members

REQUIRE

OPTIONAL

Variables

http: CONTINUE

readonly & Continue(default {})

The common status code response constant of Continue.

http: SWITCHING_PROTOCOLS

readonly & SwitchingProtocols(default {})

The common status code response constant of SwitchingProtocols.

http: PROCESSING

readonly & Processing(default {})

The common status code response constant of Processing.

http: EARLY_HINTS

readonly & EarlyHints(default {})

The common status code response constant of EarlyHints.

http: OK

readonly & Ok(default {})

The common status code response constant of Ok.

http: CREATED

readonly & Created(default {})

The common status code response constant of Created.

http: ACCEPTED

readonly & Accepted(default {})

The common status code response constant of Accepted.

http: NON_AUTHORITATIVE_INFORMATION

readonly & NonAuthoritativeInformation(default {})

The common status code response constant of NonAuthoritativeInformation.

http: NO_CONTENT

readonly & NoContent(default {})

The common status code response constant of NoContent.

http: RESET_CONTENT

readonly & ResetContent(default {})

The common status code response constant of ResetContent.

http: PARTIAL_CONTENT

readonly & PartialContent(default {})

The common status code response constant of PartialContent.

http: MULTI_STATUS

readonly & MultiStatus(default {})

The common status code response constant of MultiStatus.

http: ALREADY_REPORTED

readonly & AlreadyReported(default {})

The common status code response constant of AlreadyReported.

http: IM_USED

readonly & IMUsed(default {})

The common status code response constant of IMUsed.

http: MULTIPLE_CHOICES

readonly & MultipleChoices(default {})

The common status code response constant of MultipleChoices.

http: MOVED_PERMANENTLY

readonly & MovedPermanently(default {})

The common status code response constant of MovedPermanently.

http: FOUND

readonly & Found(default {})

The common status code response constant of Found.

http: SEE_OTHER

readonly & SeeOther(default {})

The common status code response constant of SeeOther.

http: NOT_MODIFIED

readonly & NotModified(default {})

The common status code response constant of NotModified.

http: USE_PROXY

readonly & UseProxy(default {})

The common status code response constant of UseProxy.

http: TEMPORARY_REDIRECT

readonly & TemporaryRedirect(default {})

The common status code response constant of TemporaryRedirect.

http: PERMANENT_REDIRECT

readonly & PermanentRedirect(default {})

The common status code response constant of PermanentRedirect.

http: BAD_REQUEST

readonly & BadRequest(default {})

The common status code response constant of BadRequest.

http: UNAUTHORIZED

readonly & Unauthorized(default {})

The common status code response constant of Unauthorized.

http: PAYMENT_REQUIRED

readonly & PaymentRequired(default {})

The common status code response constant of PaymentRequired.

http: FORBIDDEN

readonly & Forbidden(default {})

The common status code response constant of Forbidden.

http: NOT_FOUND

readonly & NotFound(default {})

The common status code response constant of NotFound.

http: METHOD_NOT_ALLOWED

readonly & MethodNotAllowed(default {})

The common status code response constant of MethodNotAllowed.

http: NOT_ACCEPTABLE

readonly & NotAcceptable(default {})

The common status code response constant of NotAcceptable.

http: PROXY_AUTHENTICATION_REQUIRED

readonly & ProxyAuthenticationRequired(default {})

The common status code response constant of ProxyAuthenticationRequired.

http: REQUEST_TIMEOUT

readonly & RequestTimeout(default {})

The common status code response constant of RequestTimeout.

http: CONFLICT

readonly & Conflict(default {})

The common status code response constant of Conflict.

http: GONE

readonly & Gone(default {})

The common status code response constant of Gone.

http: LENGTH_REQUIRED

readonly & LengthRequired(default {})

The common status code response constant of LengthRequired.

http: PRECONDITION_FAILED

readonly & PreconditionFailed(default {})

The common status code response constant of PreconditionFailed.

http: PAYLOAD_TOO_LARGE

readonly & PayloadTooLarge(default {})

The common status code response constant of PayloadTooLarge.

http: URI_TOO_LONG

readonly & UriTooLong(default {})

The common status code response constant of UriTooLong.

http: UNSUPPORTED_MEDIA_TYPE

readonly & UnsupportedMediaType(default {})

The common status code response constant of UnsupportedMediaType.

http: RANGE_NOT_SATISFIABLE

readonly & RangeNotSatisfiable(default {})

The common status code response constant of RangeNotSatisfiable.

http: EXPECTATION_FAILED

readonly & ExpectationFailed(default {})

The common status code response constant of ExpectationFailed.

http: MISDIRECTED_REQUEST

readonly & MisdirectedRequest(default {})

The common status code response constant of MisdirectedRequest.

http: UNPROCESSABLE_ENTITY

readonly & UnprocessableEntity(default {})

The common status code response constant of UnprocessableEntity.

http: LOCKED

readonly & Locked(default {})

The common status code response constant of Locked.

http: FAILED_DEPENDENCY

readonly & FailedDependency(default {})

The common status code response constant of FailedDependency.

http: TOO_EARLY

readonly & TooEarly(default {})

The common status code response constant of TooEarly.

http: PREDICTION_REQUIRED

readonly & PreconditionRequired(default {})

The common status code response constant of PreconditionRequired.

http: UNAVAILABLE_DUE_TO_LEGAL_REASONS

readonly & UnavailableDueToLegalReasons(default {})

The common status code response constant of UnavailableDueToLegalReasons.

http: UPGRADE_REQUIRED

readonly & UpgradeRequired(default {})

The common status code response constant of UpgradeRequired.

http: TOO_MANY_REQUESTS

readonly & TooManyRequests(default {})

The common status code response constant of TooManyRequests.

http: REQUEST_HEADER_FIELDS_TOO_LARGE

readonly & RequestHeaderFieldsTooLarge(default {})

The common status code response constant of RequestHeaderFieldsTooLarge.

http: INTERNAL_SERVER_ERROR

readonly & InternalServerError(default {})

The common status code response constant of InternalServerError.

http: NOT_IMPLEMENTED

readonly & NotImplemented(default {})

The common status code response constant of NotImplemented.

http: BAD_GATEWAY

readonly & BadGateway(default {})

The common status code response constant of BadGateway.

http: SERVICE_UNAVAILABLE

readonly & ServiceUnavailable(default {})

The common status code response constant of ServiceUnavailable.

http: GATEWAY_TIMEOUT

readonly & GatewayTimeout(default {})

The common status code response constant of GatewayTimeout.

http: HTTP_VERSION_NOT_SUPPORTED

readonly & HttpVersionNotSupported(default {})

The common status code response constant of HttpVersionNotSupported.

http: VARIANT_ALSO_NEGOTIATES

readonly & VariantAlsoNegotiates(default {})

The common status code response constant of VariantAlsoNegotiates.

http: INSUFFICIENT_STORAGE

readonly & InsufficientStorage(default {})

The common status code response constant of InsufficientStorage.

http: LOOP_DETECTED

readonly & LoopDetected(default {})

The common status code response constant of LoopDetected.

http: NOT_EXTENDED

readonly & NotExtended(default {})

The common status code response constant of NotExtended.

http: NETWORK_AUTHENTICATION_REQUIRED

readonly & NetworkAuthenticationRequired(default {})

The common status code response constant of NetworkAuthenticationRequired.

Listeners

http: Listener

Isolated

This is used for creating HTTP server endpoints. An HTTP server endpoint is capable of responding to remote callers. The Listener is responsible for initializing the endpoint using the provided configurations.

Constructor

Gets invoked during module initialization to initialize the listener.

init (int port, *ListenerConfiguration config)

port int - Listening port of the HTTP service listener

config *ListenerConfiguration - Configurations for the HTTP service listener

attach

Isolated Function

function attach(Service httpService, string[]|string? name) returns error?

Attaches a service to the listener.

Parameters

httpService Service - The service that needs to be attached

name string[]|string? (default ()) - Name of the service

Return Type

error? - An error if an error occurred during the service attachment process or else ()

'start

Isolated Function

function 'start() returns error?

Starts the registered service programmatically.

Return Type

error? - An error if an error occurred during the listener starting process

gracefulStop

Isolated Function

function gracefulStop() returns error?

Stops the service listener gracefully. Already-accepted requests will be served before connection closure.

Return Type

error? - An error if an error occurred during the listener stopping process

immediateStop

Isolated Function

function immediateStop() returns error?

Stops the service listener immediately. It is not implemented yet.

Return Type

error? - An error if an error occurred during the listener stop process

detach

Isolated Function

function detach(Service httpService) returns error?

Detaches an HTTP service from the listener.

Parameters

httpService Service - The service to be detached

Return Type

error? - An error if one occurred during detaching of a service or else ()

getPort

Isolated Function

function getPort() returns int

Retrieves the port of the HTTP listener.

Return Type

int - The HTTP listener port

getConfig

Isolated Function

function getConfig() returns readonly & InferredListenerConfiguration

Retrieves the InferredListenerConfiguration of the HTTP listener.

Return Type

readonly & InferredListenerConfiguration - The readonly HTTP listener inferred configuration

Annotations

http: Cache

HttpCacheConfig

return

The annotation which is used to define the response cache configuration. This annotation only supports anydata and Success(2XX) StatusCodeResponses return types. Default annotation adds must-revalidate,public,max-age=3600 as cache-control header in addition to etag and last-modified headers.

http: CallerInfo

HttpCallerInfo

parameter

The annotation which is used to configure the type of the response.

HttpHeader

parameter

The annotation which is used to define the Header resource signature parameter.

http: Payload

HttpPayload

parameter, return

The annotation which is used to define the Payload resource signature parameter and return parameter.

http: Query

HttpQuery

parameter

The annotation which is used to define the query resource signature parameter.

http: ResourceConfig

HttpResourceConfig

object function

The annotation which is used to configure an HTTP resource.

http: ServiceConfig

HttpServiceConfig

service, type

The annotation which is used to configure an HTTP service.

Configurables

http: traceLogConsole

boolean(default false)

http: traceLogAdvancedConfig

TraceLogAdvancedConfiguration(default {})

http: accessLogConfig

AccessLogConfiguration(default {})

http: maxActiveConnections

int(default -1)

http: maxIdleConnections

int(default 100)

http: waitTime

decimal(default 30)

http: maxActiveStreamsPerConnection

int(default 100)

http: minEvictableIdleTime

decimal(default 300)

http: timeBetweenEvictionRuns

decimal(default 30)

http: minIdleTimeInStaleState

decimal(default 300)

http: timeBetweenStaleEviction

decimal(default 30)

Records

http: Accepted

Closed record

The status code response record of Accepted.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusAccepted(default STATUS_ACCEPTED_OBJ) - The response status code obj

http: AccessLogConfiguration

Closed record

Represents HTTP access log configuration.

Fields

console boolean(default false) - Boolean value to enable or disable console access logs

format string(default "flat") - The format of access logs to be printed (either flat or json)

attributes? string[] - The list of attributes of access logs to be printed

path? string - Optional file path to store access logs

http: AlreadyReported

Closed record

The status code response record of AlreadyReported.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusAlreadyReported(default STATUS_ALREADY_REPORTED_OBJ) - The response status code obj

http: BadGateway

Closed record

The status code response record of BadGateway.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusBadGateway(default STATUS_BAD_GATEWAY_OBJ) - The response status code obj

http: BadRequest

Closed record

The status code response record of BadRequest.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusBadRequest(default STATUS_BAD_REQUEST_OBJ) - The response status code obj

http: BearerTokenConfig

Closed record

Represents token for Bearer token authentication.

Fields

token string - Bearer token for authentication

http: Bucket

Closed record

Represents a discrete sub-part of the time window (Bucket).

Fields

totalCount int(default 0) - Total number of requests received during the sub-window time frame

failureCount int(default 0) - Number of failed requests during the sub-window time frame

rejectedCount int(default 0) - Number of rejected requests during the sub-window time frame

lastUpdatedTime? Utc - The time that the Bucket is last updated.

http: CacheConfig

Closed record

Provides a set of configurations for controlling the caching behaviour of the endpoint.

Fields

enabled boolean(default true) - Specifies whether HTTP caching is enabled. Caching is enabled by default.

isShared boolean(default false) - Specifies whether the HTTP caching layer should behave as a public cache or a private cache

capacity int(default 16) - The capacity of the cache

evictionFactor float(default 0.2) - The fraction of entries to be removed when the cache is full. The value should be between 0 (exclusive) and 1 (inclusive).

policy CachingPolicy(default CACHE_CONTROL_AND_VALIDATORS) - Gives the user some control over the caching behaviour. By default, this is set to CACHE_CONTROL_AND_VALIDATORS. The default behaviour is to allow caching only when the cache-control header and either the etag or last-modified header are present.

http: CertKey

Closed record

Represents combination of certificate, private key and private key password if encrypted.

Fields

certFile string - A file containing the certificate

keyFile string - A file containing the private key in PKCS8 format

keyPassword? string - Password of the private key if it is encrypted

http: CircuitBreakerConfig

Closed record

Provides a set of configurations for controlling the behaviour of the Circuit Breaker.

Fields

rollingWindow RollingWindow(default {}) - The http:RollingWindow options of the CircuitBreaker

failureThreshold float(default 0.0) - The threshold for request failures. When this threshold exceeds, the circuit trips. The threshold should be a value between 0 and 1

resetTime decimal(default 0) - The time period (in seconds) to wait before attempting to make another request to the upstream service

statusCodes int[](default []) - Array of HTTP response status codes which are considered as failures

http: CircuitBreakerInferredConfig

Closed record

Derived set of configurations from the CircuitBreakerConfig.

Fields

failureThreshold float(default 0.0) - The threshold for request failures. When this threshold exceeds, the circuit trips. The threshold should be a value between 0 and 1

resetTime decimal(default 0) - The time period (in seconds) to wait before attempting to make another request to the upstream service

statusCodes int[](default []) - Array of HTTP response status codes which are considered as failures

noOfBuckets int(default 0) - Number of buckets derived from the RollingWindow

rollingWindow RollingWindow(default {}) - The http:RollingWindow options provided in the http:CircuitBreakerConfig

http: CircuitHealth

Closed record

Maintains the health of the Circuit Breaker.

Fields

lastRequestSuccess boolean(default false) - Whether last request is success or not

totalRequestCount int(default 0) - Total request count received within the RollingWindow

lastUsedBucketId int(default 0) - ID of the last bucket used in Circuit Breaker calculations

startTime Utc(default time:utcNow()) - Circuit Breaker start time

lastRequestTime? Utc - The time that the last request received

lastErrorTime? Utc - The time that the last error occurred

lastForcedOpenTime? Utc - The time that circuit forcefully opened at last

totalBuckets Bucket?[](default []) - The discrete time buckets into which the time window is divided

http: ClientConfiguration

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. The following fields are inherited from the other configuration records in addition to the Client-specific configs.

Fields

Fields Included from *CommonClientConfiguration

httpVersion HttpVersion
http1Settings ClientHttp1Settings
http2Settings ClientHttp2Settings
timeout decimal
forwarded string
followRedirects FollowRedirects|()
poolConfig PoolConfiguration|()
cache CacheConfig
compression Compression
auth CredentialsConfig|BearerTokenConfig|JwtIssuerConfig|OAuth2ClientCredentialsGrantConfig|OAuth2PasswordGrantConfig|OAuth2RefreshTokenGrantConfig|OAuth2JwtBearerGrantConfig|()
circuitBreaker CircuitBreakerConfig|()
retryConfig RetryConfig|()
cookieConfig CookieConfig|()
responseLimits ResponseLimitConfigs
proxy ProxyConfig|()
validation boolean
socketConfig ClientSocketConfig

secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options

http: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig?(default ()) - Proxy server related options

http: ClientHttp2Settings

Closed record

Provides settings related to HTTP/2 protocol.

Fields

http2PriorKnowledge boolean(default false) - Configuration to enable HTTP/2 prior knowledge

http2InitialWindowSize int(default 65535) - Configuration to change the initial window size

http: ClientSecureSocket

Closed record

Provides configurations for facilitating secure communication with a remote HTTP endpoint.

Fields

enable boolean(default true) - Enable SSL validation

cert? TrustStore|string - Configurations associated with crypto:TrustStore or single certificate file that the client trusts

key? KeyStore|CertKey - Configurations associated with crypto:KeyStore or combination of certificate and private key of the client

protocol? record {| name Protocol, versions string[] |} - SSL/TLS protocol related options

certValidation? record {| 'type CertValidationType, cacheSize int, cacheValidityPeriod int |} - Certificate validation against OCSP_CRL, OCSP_STAPLING related options

ciphers? string[] - List of ciphers to be used eg: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

verifyHostName boolean(default true) - Enable/disable host name verification

shareSession boolean(default true) - Enable/disable new SSL session creation

handshakeTimeout? decimal - SSL handshake time out

sessionTimeout? decimal - SSL session time out

http: ClientSocketConfig

Closed record

Provides settings related to client socket configuration.

Fields

connectTimeOut decimal(default 15) - Connect timeout of the channel in seconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

receiveBufferSize int(default 1048576) - Sets the SO_RCVBUF option to the specified value for this Socket.

sendBufferSize int(default 1048576) - Sets the SO_SNDBUF option to the specified value for this Socket.

tcpNoDelay boolean(default true) - Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

socketReuse boolean(default true) - Enable/disable the SO_REUSEADDR socket option.

keepAlive boolean(default false) - Enable/disable SO_KEEPALIVE.

http: CommonClientConfiguration

Closed record

Common client configurations for the next level clients.

Fields

httpVersion HttpVersion(default HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection

poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

auth ClientAuthConfig?(default ()) - Configurations related to client authentication

circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig?(default ()) - Configurations associated with retrying

cookieConfig CookieConfig?(default ()) - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

proxy ProxyConfig?(default ()) - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionalty which provided by the constraint package. Enabled by default

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

http: CommonResponse

Closed record

The common attributed of response status code record type.

Fields

mediaType? string - The value of response Content-type header

headers? map<string|int|boolean|string[]|int[]|boolean[]> - The response headers

body? anydata - The response payload

http: CompressionConfig

Closed record

A record for providing configurations for content compression.

Fields

enable Compression(default COMPRESSION_AUTO) - The status of compression

contentTypes string[](default []) - Content types which are allowed for compression

http: Conflict

Closed record

The status code response record of Conflict.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusConflict(default STATUS_CONFLICT_OBJ) - The response status code obj

http: Continue

Closed record

The status code response record of Continue.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusContinue(default STATUS_CONTINUE_OBJ) - The response status code obj

http: CookieConfig

Closed record

Client configuration for cookies.

Fields

enabled boolean(default false) - User agents provide users with a mechanism for disabling or enabling cookies

maxCookiesPerDomain int(default 50) - Maximum number of cookies per domain, which is 50

maxTotalCookieCount int(default 3000) - Maximum number of total cookies allowed to be stored in cookie store, which is 3000

blockThirdPartyCookies boolean(default true) - User can block cookies from third party responses and refuse to send cookies for third party requests, if needed

persistentCookieHandler? PersistentCookieHandler - To manage persistent cookies, users are provided with a mechanism for specifying a persistent cookie store with their own mechanism which references the persistent cookie handler or specifying the CSV persistent cookie handler. If not specified any, only the session cookies are used

http: CookieOptions

Closed record

The options to be used when initializing the http:Cookie.

Fields

path? string - URI path to which the cookie belongs

domain? string - Host to which the cookie will be sent

expires? string - Maximum lifetime of the cookie represented as the date and time at which the cookie expires

maxAge int(default 0) - Maximum lifetime of the cookie represented as the number of seconds until the cookie expires

httpOnly boolean(default false) - Cookie is sent only to HTTP requests

secure boolean(default false) - Cookie is sent only to secure channels

createdTime Utc(default time:utcNow()) - At what time the cookie was created

lastAccessedTime Utc(default time:utcNow()) - Last-accessed time of the cookie

hostOnly boolean(default false) - Cookie is sent only to the requested host

http: CorsConfig

Closed record

Configurations for CORS support.

Fields

allowHeaders string[](default []) - The array of allowed headers by the service

allowMethods string[](default []) - The array of allowed methods by the service

allowOrigins string[](default []) - The array of origins with which the response is shared by the service

exposeHeaders string[](default []) - The allowlisted headers, which clients are allowed to access

allowCredentials boolean(default false) - Specifies whether credentials are required to access the service

maxAge decimal(default -1) - The maximum duration to cache the preflight from client side

http: Created

Closed record

The status code response record of Created.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusCreated(default STATUS_CREATED_OBJ) - The response status code obj

http: CredentialsConfig

Closed record

Represents credentials for Basic Auth authentication.

Fields

Fields Included from *CredentialsConfig

username string
password string

http: DefaultStatusCodeResponse

Closed record

The default status code response record.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly DefaultStatus - The response status code object

http: Detail

Represents the details of an HTTP error.

Fields

statusCode int - The inbound error response status code

headers map<string[]> - The inbound error response headers

body anydata - The inbound error response body

http: EarlyHints

Closed record

The status code response record of EarlyHints.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusEarlyHints(default STATUS_EARLY_HINTS_OBJ) - The response status code obj

http: ErrorPayload

Represents the structure of the HTTP error payload.

Fields

timestamp string - Timestamp of the error

status int - Relevant HTTP status code

reason string - Reason phrase

message string - Error message

path string - Request path

method string - Method type of the request

http: ExpectationFailed

Closed record

The status code response record of ExpectationFailed.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusExpectationFailed(default STATUS_EXPECTATION_FAILED_OBJ) - The response status code obj

http: FailedDependency

Closed record

The status code response record of FailedDependency.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusFailedDependency(default STATUS_FAILED_DEPENDENCY_OBJ) - The response status code obj

http: FailoverClientConfiguration

Closed record

Provides a set of HTTP related configurations and failover related configurations. The following fields are inherited from the other configuration records in addition to the failover client-specific configs.

Fields

Fields Included from *CommonClientConfiguration

httpVersion HttpVersion
http1Settings ClientHttp1Settings
http2Settings ClientHttp2Settings
timeout decimal
forwarded string
followRedirects FollowRedirects|()
poolConfig PoolConfiguration|()
cache CacheConfig
compression Compression
auth CredentialsConfig|BearerTokenConfig|JwtIssuerConfig|OAuth2ClientCredentialsGrantConfig|OAuth2PasswordGrantConfig|OAuth2RefreshTokenGrantConfig|OAuth2JwtBearerGrantConfig|()
circuitBreaker CircuitBreakerConfig|()
retryConfig RetryConfig|()
cookieConfig CookieConfig|()
responseLimits ResponseLimitConfigs
proxy ProxyConfig|()
validation boolean
socketConfig ClientSocketConfig

targets TargetService[](default []) - The upstream HTTP endpoints among which the incoming HTTP traffic load should be sent on failover

failoverCodes int[](default [501, 502, 503, 504]) - Array of HTTP response status codes for which the failover behaviour should be triggered

interval decimal(default 0) - Failover delay interval in seconds

http: FileUserStoreConfig

Closed record

Represents file user store configurations for Basic Auth authentication.

http: FileUserStoreConfigWithScopes

Closed record

Represents the auth annotation for file user store configurations with scopes.

Fields

fileUserStoreConfig FileUserStoreConfig - File user store configurations for Basic Auth authentication

scopes? string|string[] - Scopes allowed for authorization

http: FollowRedirects

Closed record

Provides configurations for controlling the endpoint's behaviour in response to HTTP redirect related responses. The response status codes of 301, 302, and 303 are redirected using a GET request while 300, 305, 307, and 308 status codes use the original request HTTP method during redirection.

Fields

enabled boolean(default false) - Enable/disable redirection

maxCount int(default 5) - Maximum number of redirects to follow

allowAuthHeaders boolean(default false) - By default Authorization and Proxy-Authorization headers are removed from the redirect requests. Set it to true if Auth headers are needed to be sent during the redirection

http: Forbidden

Closed record

The status code response record of Forbidden.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusForbidden(default STATUS_FORBIDDEN_OBJ) - The response status code obj

http: Found

Closed record

The status code response record of Found.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusFound(default STATUS_FOUND_OBJ) - The response status code obj

http: GatewayTimeout

Closed record

The status code response record of GatewayTimeout.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusGatewayTimeout(default STATUS_GATEWAY_TIMEOUT_OBJ) - The response status code obj

http: Gone

Closed record

The status code response record of Gone.

Fields

Fields Included from *CommonResponse

mediaType string
headers map<string|int|boolean|string[]|int[]|boolean[]>
body anydata

statusreadonly StatusGone(default STATUS_GONE_OBJ) - The response status code obj

http: HeaderValue

Closed record

Represents the parsed header value details

Fields

value string - The header value

params map<string> - Map of header parameters

http: HttpCacheConfig

Closed record

Defines the HTTP response cache configuration. By default the no-cache directive is setted to the cache-control header. In addition to that etag and

functions

classes

clients

serviceTypes

constants

enums

variables

listeners

annotations

configurables

records

errors

objectTypes

unionTypes

intersectionTypes

typeDescriptorTypes

ballerina/http Ballerina library

Overview

Client

Resiliency

Security

Listener

Security

Functions

authenticateResource

Parameters

createHttpCachingClient

Parameters

Return Type

createHttpSecureClient

Parameters

Return Type

parseHeader

Parameters

Return Type

Classes

http: ClientBasicAuthHandler

Constructor

enrich

Parameters

Return Type

enrichHeaders

Parameters

Return Type

getSecurityHeaders

Return Type

http: ClientBearerTokenAuthHandler

Constructor

enrich

Parameters

Return Type

enrichHeaders

Parameters

Return Type

getSecurityHeaders

Return Type

http: ClientSelfSignedJwtAuthHandler

Constructor

enrich

Parameters

Return Type

enrichHeaders

Parameters

Return Type

getSecurityHeaders

Return Type

http: Cookie

Constructor

isPersistent

Return Type

isValid

Return Type

toStringValue

Return Type

Fields

http: CookieStore

addCookie

Parameters

Return Type

addCookies