Module http
ballerina/http Ballerina library
Functions
authenticateResource
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.
createHttpCachingClient
function createHttpCachingClient(string url, ClientConfiguration config, CacheConfig cacheConfig) returns HttpClient|ClientErrorCreates 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:HttpCachingClientinstance, which wraps the basehttp:Clientwith a caching layer or else anhttp:ClientError
createHttpSecureClient
function createHttpSecureClient(string url, ClientConfiguration config) returns HttpClient|ClientErrorCreates an HTTP client capable of securing HTTP requests with authentication.
Return Type
- HttpClient|ClientError - Created secure HTTP client
getDefaultListener
function getDefaultListener() returns Listener|ListenerErrorReturns the default HTTP listener. If the default listener is not already created, a new listener will be created with the port and configuration. An error will be returned if the listener creation fails.
The default listener configuration can be changed in the Config.toml file. Example:
[ballerina.http] defaultListenerPort = 8080 [ballerina.http.defaultListenerConfig] httpVersion = "1.1" [ballerina.http.defaultListenerConfig.secureSocket.key] path = "resources/certs/key.pem" password = "password"
Return Type
- Listener|ListenerError - The default HTTP listener or an error if the listener creation fails.
getHeaderMap
Converts the headers represented as a map of anydata to a map of string or string array. The value:toString
method will be used to convert the values to string. Additionally if the header name is specified by the
http:Header annotation, then it will be used as the header name.
type Headers record { @http:Header {name: "X-API-VERSION"} string apiVersion; int id; }; Headers headers = {apiVersion: "v1", id: 1}; map<string|string[]> headersMap = http:getHeaderMap(headers); // { "X-API-VERSION": "v1", "id": "1" }
Parameters
- headers map<anydata> - The headers represented as a map of anydata
getQueryMap
If the query name is specified by the http:Query annotation, then this function will return the queries map
with the specified query name. Otherwise, it will return the map as it is.
type Queries record { @http:Query {name: "filter_ids"} string[] ids; }; Queries queries = {ids: ["1", "2"]}; map<anydata> queriesMap = http:getQueryMap(queries); // { "filter_ids": ["1", "2"] }
Parameters
- queries map<anydata> - The queries represented as a map of anydata
Return Type
- map<anydata> - The queries map with names specified by the
http:Queryannotation
parseHeader
function parseHeader(string headerValue) returns HeaderValue[]|ClientErrorParses 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:HeaderValuetyped record containing the value and its parameter map or else anhttp:ClientErrorif the header parsing fails
Classes
http: ClientBasicAuthHandler
Defines the Basic Auth handler for client authentication.
Constructor
Initializes the http:ClientBasicAuthHandler object.
init (CredentialsConfig config)- config CredentialsConfig - The
http:CredentialsConfiginstance
enrich
function enrich(Request req) returns Request|ClientAuthErrorEnrich the request with the relevant authentication requirements.
Parameters
- req Request - The
http:Requestinstance
Return Type
- Request|ClientAuthError - The updated
http:Requestinstance or else anhttp:ClientAuthErrorin case of an error
enrichHeaders
Enrich the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
getSecurityHeaders
function getSecurityHeaders() returns map<string|string[]>|ClientAuthErrorReturns the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
http: ClientBearerTokenAuthHandler
Defines the Bearer token auth handler for client authentication.
Constructor
Initializes the http:ClientBearerTokenAuthHandler object.
init (BearerTokenConfig config)- config BearerTokenConfig - The
http:BearerTokenConfiginstance
enrich
function enrich(Request req) returns Request|ClientAuthErrorEnrich the request with the relevant authentication requirements.
Parameters
- req Request - The
http:Requestinstance
Return Type
- Request|ClientAuthError - The updated
http:Requestinstance or else anhttp:ClientAuthErrorin case of an error
enrichHeaders
Enrich the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
getSecurityHeaders
function getSecurityHeaders() returns map<string|string[]>|ClientAuthErrorReturns the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
http: ClientSelfSignedJwtAuthHandler
Defines the self signed JWT handler for client authentication.
Constructor
Initializes the http:ClientSelfSignedJwtAuthProvider object.
init (JwtIssuerConfig config)- config JwtIssuerConfig - The
http:JwtIssuerConfiginstance
enrich
function enrich(Request req) returns Request|ClientAuthErrorEnrich the request with the relevant authentication requirements.
Parameters
- req Request - The
http:Requestinstance
Return Type
- Request|ClientAuthError - The updated
http:Requestinstance or else anhttp:ClientAuthErrorin case of an error
enrichHeaders
Enrich the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
getSecurityHeaders
function getSecurityHeaders() returns map<string|string[]>|ClientAuthErrorReturns the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
http: Cookie
Represents a Cookie.
Constructor
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
isPersistent
function isPersistent() returns booleanChecks the persistence of the cookie.
Return Type
- boolean -
falseif the cookie will be discarded at the end of the "session" or elsetrue.
isValid
function isValid() returns boolean|InvalidCookieErrorChecks the validity of the attributes of the cookie.
Return Type
- boolean|InvalidCookieError -
trueif the attributes of the cookie are in the correct format or else anhttp:InvalidCookieError
toStringValue
function toStringValue() returns stringGets 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
Represents the cookie store.
addCookie
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:CookieHandlingErrorif there is any error occurred when adding a cookie or else()
addCookies
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
Gets the relevant cookies for the given URL and the path according to the rules in RFC-6265.
Return Type
- Cookie[] - Array of the matched cookies stored in the cookie store
getAllCookies
function getAllCookies() returns Cookie[]Gets all the cookies in the cookie store.
Return Type
- Cookie[] - Array of all the cookie objects
getCookiesByName
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
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
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:CookieHandlingErrorif there is any error occurred during the removal of the cookie or else()
removeCookiesByDomain
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:CookieHandlingErrorif there is any error occurred during the removal of cookies by domain or else()
removeExpiredCookies
function removeExpiredCookies() returns CookieHandlingError?Removes all expired cookies.
Return Type
- CookieHandlingError? - An
http:CookieHandlingErrorif there is any error occurred during the removal of expired cookies or else()
removeAllCookies
function removeAllCookies() returns CookieHandlingError?Removes all the cookies.
Return Type
- CookieHandlingError? - An
http:CookieHandlingErrorif there is any error occurred during the removal of all the cookies or else()
http: CsvPersistentCookieHandler
Represents a default persistent cookie handler, which stores persistent cookies in a CSV file.
storeCookie
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
function getAllCookies() returns Cookie[]|CookieHandlingErrorGets 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
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
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
The default status code class.
Fields
- Fields Included from *Status
- code int
http: Headers
Represents the headers of the inbound request.
hasHeader
Checks whether the requested header key exists in the header map.
Parameters
- headerName string - The header name
Return Type
- boolean -
trueif the specified header key exists
getHeader
function getHeader(string headerName) returns string|HeaderNotFoundErrorReturns 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
HeaderNotFoundErrorif the header is not found.
getHeaders
function getHeaders(string headerName) returns string[]|HeaderNotFoundErrorGets 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
HeaderNotFoundErrorif the header is not found.
getHeaderNames
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
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
Defines the file store Basic Auth handler for listener authentication.
Constructor
Initializes the http:ListenerFileUserStoreBasicAuthHandler object.
init (FileUserStoreConfig config)- config FileUserStoreConfig {} - The
http:FileUserStoreConfiginstance
authenticate
function authenticate(Request|Headers|string data) returns UserDetails|UnauthorizedAuthenticates with the relevant authentication requirements.
Parameters
Return Type
- UserDetails|Unauthorized - The
auth:UserDetailsinstance or elseUnauthorizedtype in case of an error
authorize
Authorizes with the relevant authorization requirements.
Parameters
- userDetails UserDetails - The
auth:UserDetailsinstance which is received from authentication results
Return Type
- Forbidden? -
(), if it is successful or elseForbiddentype in case of an error
http: ListenerJwtAuthHandler
Defines the JWT auth handler for listener authentication.
Constructor
Initializes the http:ListenerJwtAuthHandler object.
init (JwtValidatorConfig config)- config JwtValidatorConfig - The
http:JwtValidatorConfiginstance
authenticate
function authenticate(Request|Headers|string data) returns Payload|UnauthorizedAuthenticates with the relevant authentication requirements.
Parameters
Return Type
- Payload|Unauthorized - The
jwt:Payloadinstance or elseUnauthorizedtype in case of an error
authorize
Authorizes with the relevant authorization requirements.
Parameters
- jwtPayload Payload - The
jwt:Payloadinstance which is received from authentication results
Return Type
- Forbidden? -
(), if it is successful or elseForbiddentype in case of an error
http: LoadBalancerRoundRobinRule
Implementation of round robin load balancing strategy.
getNextClient
function getNextClient(Client?[] loadBalanceCallerActionsArray) returns Client|ClientErrorProvides 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:Clientfrom the algorithm or else anhttp:ClientErrorfor 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)hasHeader
Checks whether the requested header exists.
Parameters
- headerName string - The header name
Return Type
- boolean - A
booleanrepresenting the existence of a given header
getHeader
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
Gets transport headers from the PushPromise.
Parameters
- headerName string - The header name
Return Type
- string[] - The array of header values
addHeader
Adds the specified key/value pair as an HTTP header to the http:PushPromise. In the case of the Content-Type
header, the existing value is replaced with the specified value.
setHeader
Sets the value of a transport header in the http:PushPromise.
removeHeader
function removeHeader(string headerName)Removes a transport header from the http:PushPromise.
Parameters
- headerName string - The header name
removeAllHeaders
function removeAllHeaders()Removes all transport headers from the http:PushPromise.
getHeaderNames
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
function setEntity(Entity e)Sets the provided Entity to the request.
Parameters
- e Entity - The
Entityto be set to the request
getQueryParams
Gets the query parameters of the request as a map consisting of a string array.
getQueryParamValue
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
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
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
function getEntity() returns Entity|ClientErrorGets the Entity associated with the request.
Return Type
- Entity|ClientError - The
Entityof the request. Anhttp:ClientErroris returned, if entity construction fails
hasHeader
Checks whether the requested header key exists in the header map.
Parameters
- headerName string - The header name
Return Type
- boolean -
trueif the specified header key exists
getHeader
function getHeader(string headerName) returns string|HeaderNotFoundErrorReturns 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
HeaderNotFoundErrorif the header is not found.
getHeaders
function getHeaders(string headerName) returns string[]|HeaderNotFoundErrorGets 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
HeaderNotFoundErrorif the header is not found.
setHeader
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.
addHeader
Adds the specified header to the request. Existing header values are not replaced, except for the Content-Type
header. In the case of the Content-Type header, the existing value is replaced with the specified value.
Panic if an illegal header is passed.
removeHeader
function removeHeader(string headerName)Removes the specified header from the request.
Parameters
- headerName string - The header name
removeAllHeaders
function removeAllHeaders()Removes all the headers from the request.
getHeaderNames
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
function expects100Continue() returns booleanChecks whether the client expects a 100-continue response.
Return Type
- boolean -
trueif the client expects a100-continueresponse
setContentType
Sets the content-type header to the request.
Parameters
- contentType string - Content type value to be set as the
content-typeheader
Return Type
- error? - Nil if successful, error in case of invalid content-type
getContentType
function getContentType() returns stringGets the type of the payload of the request (i.e: the content-type header value).
Return Type
- string - The
content-typeheader value as a string
getJsonPayload
function getJsonPayload() returns json|ClientErrorExtract 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
jsonpayload orhttp:ClientErrorin case of errors
getXmlPayload
function getXmlPayload() returns xml|ClientErrorExtracts 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
xmlpayload orhttp:ClientErrorin case of errors
getTextPayload
function getTextPayload() returns string|ClientErrorExtracts 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
textpayload orhttp:ClientErrorin case of errors
getByteStream
function getByteStream(int arraySize) returns stream<byte[], Error?>|ClientErrorGets 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:ClientErrorin case of errors
getBinaryPayload
function getBinaryPayload() returns byte[]|ClientErrorGets the request payload as a byte[].
Return Type
- byte[]|ClientError - The byte[] representation of the message payload or
http:ClientErrorin case of errors
getFormParams
function getFormParams() returns map<string>|ClientErrorGets 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:ClientErrorin case of errors
getBodyParts
function getBodyParts() returns Entity[]|ClientErrorExtracts 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:ClientErrorif there were any errors constructing the body parts from the request
setJsonPayload
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. If the given payload is a record type with
the @jsondata:Name annotation, the jsondata:toJson function internally converts the record to JSON
Parameters
- payload json - The
jsonpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
application/jsonis the default value
setXmlPayload
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
xmlpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
application/xmlis the default value
setTextPayload
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
stringpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
text/plainis the default value
setBinaryPayload
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-streamis the default value
setBodyParts
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-datais the default value
setFileAsPayload
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-streamis the default value
setByteStream
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
- contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter.
The
application/octet-streamis the default value
setPayload
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
- contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter
addCookies
function addCookies(Cookie[] cookiesToAdd)Adds cookies to the request.
Parameters
- cookiesToAdd Cookie[] - Represents the cookies to be added
getCookies
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-agentheader
- 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
function buildCacheControlDirectives() returns stringBuilds 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-controlheader
Fields
- noCache boolean(default false) - Sets the
no-cachedirective
- noStore boolean(default false) - Sets the
no-storedirective
- noTransform boolean(default false) - Sets the
no-transformdirective
- onlyIfCached boolean(default false) - Sets the
only-if-cacheddirective
- maxAge decimal(default -1) - Sets the
max-agedirective
- maxStale decimal(default -1) - Sets the
max-staledirective
- minFresh decimal(default -1) - Sets the
min-freshdirective
http: RequestContext
Represents an HTTP Context that allows user to pass data between interceptors.
set
function set(string key, ReqCtxMember value)Sets a member to the request context object.
get
function get(string key) returns ReqCtxMemberGets 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
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
function keys() returns string[]Returns the member keys of the request context object.
Return Type
- string[] - Array of member keys
getWithType
function getWithType(string key, ReqCtxMemberType targetType) returns targetType|ListenerErrorGets 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
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
next
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
function getEntity() returns Entity|ClientErrorGets the Entity associated with the response.
Return Type
- Entity|ClientError - The
Entityof the response. Anhttp:ClientErroris returned, if entity construction fails
setEntity
function setEntity(Entity e)Sets the provided Entity to the response.
Parameters
- e Entity - The
Entityto be set to the response
hasHeader
function hasHeader(string headerName, HeaderPosition position) returns booleanChecks 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 -
trueif the specified header key exists
getHeader
function getHeader(string headerName, HeaderPosition position) returns string|HeaderNotFoundErrorReturns 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 theResponsemust be accessed initially.
Return Type
- string|HeaderNotFoundError - The first header value for the specified header name or the
HeaderNotFoundErrorif the header is not found.
addHeader
function addHeader(string headerName, string headerValue, HeaderPosition position)Adds the specified header to the response. Existing header values are not replaced, except for the Content-Type
header. In the case of the Content-Type header, the existing value is replaced with the specified 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 theResponsemust be accessed initially.
getHeaders
function getHeaders(string headerName, HeaderPosition position) returns string[]|HeaderNotFoundErrorGets 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 theResponsemust be accessed initially.
Return Type
- string[]|HeaderNotFoundError - The header values the specified header key maps to or the
HeaderNotFoundErrorif the header is not found.
setHeader
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 theResponsemust be accessed initially.
removeHeader
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 theResponsemust be accessed initially.
removeAllHeaders
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 theResponsemust be accessed initially.
getHeaderNames
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 theResponsemust be accessed initially.
Return Type
- string[] - An array of all the header names
setContentType
Sets the content-type header to the response.
Parameters
- contentType string - Content type value to be set as the
content-typeheader
Return Type
- error? - Nil if successful, error in case of invalid content-type
getContentType
function getContentType() returns stringGets the type of the payload of the response (i.e., the content-type header value).
Return Type
- string - The
content-typeheader value as a string
getJsonPayload
function getJsonPayload() returns json|ClientErrorExtract 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
jsonpayload orhttp:ClientErrorin case of errors
getXmlPayload
function getXmlPayload() returns xml|ClientErrorExtracts 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
xmlpayload orhttp:ClientErrorin case of errors
getTextPayload
function getTextPayload() returns string|ClientErrorExtracts 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:ClientErrorin case of errors
getByteStream
function getByteStream(int arraySize) returns stream<byte[], Error?>|ClientErrorGets 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:ClientErrorin case of errors
getBinaryPayload
function getBinaryPayload() returns byte[]|ClientErrorGets the response payload as a byte[].
Return Type
- byte[]|ClientError - The byte[] representation of the message payload or
http:ClientErrorin case of errors
getSseEventStream
function getSseEventStream() returns stream<SseEvent, error?>|ClientErrorGets the response payload as a stream of SseEvent.
Return Type
- stream<SseEvent, error?>|ClientError - A SseEvent stream from which the
http:SseEventcan be read orhttp:ClientErrorin case of errors
getBodyParts
function getBodyParts() returns Entity[]|ClientErrorExtracts 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:ClientErrorif there were any errors in constructing the body parts from the response
setETag
Sets the etag header for the given payload. The ETag is generated using a CRC32 hash isolated function.
setLastModified
function setLastModified()Sets the current time as the last-modified header.
setJsonPayload
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
jsonpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
application/jsonis the default value
setAnydataAsJsonPayload
function setAnydataAsJsonPayload(anydata payload, string? contentType)Sets a anydata payaload, as a json 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 anydata - The
jsonpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
application/jsonis the default value
setXmlPayload
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
xmlpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
application/xmlis the default value
setTextPayload
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
stringpayload
- contentType string? (default ()) - The content type of the payload. This is an optional parameter.
The
text/plainis the default value
setBinaryPayload
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-streamis the default value
setBodyParts
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-datais the default value
setFileAsPayload
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-streamis the default value
setByteStream
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
- contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter.
The
application/octet-streamis the default value
setSseEventStream
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
setPayload
function setPayload(anydata|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. If
the payload is non-json typed value then the value is converted to json using the toJson method.
Parameters
- payload anydata|Entity[]|stream<byte[], Error?>|stream<SseEvent, error?> - Payload can be of type
string,xml,byte[],json,stream<byte[], io:Error?>, stream<SseEvent, error?>(represents Server-Sent events),Entity[](i.e., a set of body parts) or any other value of typeanydatawhich will be converted tojsonusing thetoJsonmethod.
- contentType string? (default ()) - Content-type to be used with the payload. This is an optional parameter
addCookie
function addCookie(Cookie cookie)Adds the cookie to response.
Parameters
- cookie Cookie - The cookie, which is added to response
removeCookiesFromRemoteStore
function removeCookiesFromRemoteStore(Cookie... cookiesToRemove)Deletes the cookies in the client's cookie store.
Parameters
- cookiesToRemove Cookie... - Cookies to be deleted
getCookies
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
function populateFields(HttpCacheConfig cacheConfig)Parameters
- cacheConfig HttpCacheConfig -
buildCacheControlDirectives
function buildCacheControlDirectives() returns stringBuilds 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-controlheader
Fields
- mustRevalidate boolean(default false) - Sets the
must-revalidatedirective
- noCache boolean(default false) - Sets the
no-cachedirective
- noStore boolean(default false) - Sets the
no-storedirective
- noTransform boolean(default false) - Sets the
no-transformdirective
- isPrivate boolean(default false) - Sets the
privateandpublicdirectives
- proxyRevalidate boolean(default false) - Sets the
proxy-revalidatedirective
- maxAge decimal(default -1) - Sets the
max-agedirective
- sMaxAge decimal(default -1) - Sets the
s-maxagedirective
- noCacheFields string[](default []) - Optional fields for the
no-cachedirective. Before sending a listed field in a response, it must be validated with the origin server.
- privateFields string[](default []) - Optional fields for the
privatedirective. A cache can omit the fields specified and store the rest of the response.
http: StatusAccepted
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
The caller actions for responding to client requests.
respond
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:ListenerErrorif failed to respond or else()
promise
function promise(PushPromise promise) returns ListenerError?Pushes a promise to the caller.
Parameters
- promise PushPromise - Push promise message
Return Type
- ListenerError? - An
http:ListenerErrorin case of failures
pushPromisedResponse
function pushPromisedResponse(PushPromise promise, Response response) returns ListenerError?Sends a promised push response to the caller.
Return Type
- ListenerError? - An
http:ListenerErrorin case of failures while responding with the promised response
'continue
function 'continue() returns ListenerError?Sends a 100-continue response to the caller.
Return Type
- ListenerError? - An
http:ListenerErrorif failed to send the100-continueresponse or else()
redirect
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:ListenerErrorif failed to send the redirect response or else()
getRemoteHostName
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
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
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe Client.get() function can be used to send HTTP GET requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorInvokes 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, TargetType targetType) returns targetType|ClientErrorThe 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,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorSubmits 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. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp: ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelates to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorPasses the request to an actual network call.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
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]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP POST requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PUT requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PATCH requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP DELETE requests to HTTP endpoints.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe client resource function to send HTTP HEAD requests to HTTP endpoints.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP GET requests to HTTP endpoints.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
getCookieStore
function getCookieStore() returns CookieStore?Retrieves the cookie store of the client.
Return Type
- CookieStore? - The cookie store related to the client
circuitBreakerForceClose
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
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
function getCircuitBreakerCurrentState() returns CircuitStateThe circuit breaker client related method to provides the http:CircuitState of the circuit breaker.
Return Type
- CircuitState - The current
http:CircuitStateof the circuit breaker
http: ClientOAuth2Handler
Defines the OAuth2 handler for client authentication.
Constructor
Initializes the http:ClientOAuth2Handler object.
init (OAuth2GrantConfig config)- config OAuth2GrantConfig - The
http:OAuth2GrantConfiginstance
enrich
function enrich(Request req) returns Request|ClientAuthErrorEnrich the request with the relevant authentication requirements.
Parameters
- req Request - The
http:Requestinstance
Return Type
- Request|ClientAuthError - The updated
http:Requestinstance or else anhttp:ClientAuthErrorin case of an error
enrichHeaders
Enrich the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
getSecurityHeaders
function getSecurityHeaders() returns map<string|string[]>|ClientAuthErrorReturns the headers map with the relevant authentication requirements.
Return Type
- map<string|string[]>|ClientAuthError - The updated headers map or else an
http:ClientAuthErrorin case of an error
http: FailoverClient
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
Failoverinstance
post
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe POST remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe PUT remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe PATCH remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The HEAD remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe GET remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe OPTIONS remote function implementation of the Failover Connector.
Parameters
- path string - Resource path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorInvokes 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, TargetType targetType) returns targetType|ClientErrorInvokes 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,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorSubmits 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. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorRetrieves the http:Response for a previously-submitted request.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanChecks whether an http:PushPromise exists for a previously-submitted request.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorRetrieves the next available http:PushPromise for a previously-submitted request.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorRetrieves the promised server push http:Response message.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
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]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe POST resource function implementation of the Failover Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe PUT resource function implementation of the Failover Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe PATCH resource function implementation of the Failover Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe DELETE resource function implementation of the Failover Connector.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe HEAD resource function implementation of the Failover Connector.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe GET resource function implementation of the Failover Connector.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe OPTIONS resource function implementation of the Failover Connector.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
getSucceededEndpointIndex
function getSucceededEndpointIndex() returns intGets the index of the TargetService[] array which given a successful response.
Return Type
- int - The successful target endpoint index
http: ListenerLdapUserStoreBasicAuthHandler
Defines the LDAP store Basic Auth handler for listener authentication.
Constructor
Initializes the http:ListenerLdapUserStoreBasicAuthProvider object.
init (LdapUserStoreConfig config)- config LdapUserStoreConfig - The
http:LdapUserStoreConfiginstance
authenticate
function authenticate(Request|Headers|string data) returns UserDetails|UnauthorizedAuthenticates with the relevant authentication requirements.
Parameters
Return Type
- UserDetails|Unauthorized - The
auth:UserDetailsinstance or elseUnauthorizedtype in case of an error
authorize
Authorizes with the relevant authorization requirements.
Parameters
- userDetails UserDetails - The
auth:UserDetailsinstance which is received from authentication results
Return Type
- Forbidden? -
(), if it is successful or elseForbiddentype in case of an error
http: ListenerOAuth2Handler
Defines the OAuth2 handler for listener authentication.
Constructor
Initializes the http:ListenerOAuth2Handler object.
init (OAuth2IntrospectionConfig config)- config OAuth2IntrospectionConfig - The
http:OAuth2IntrospectionConfiginstance
authorize
function authorize(Request|Headers|string data, string|string[]? expectedScopes, map<string>? optionalParams) returns IntrospectionResponse|Unauthorized|ForbiddenAuthorizes with the relevant authentication & authorization requirements.
Parameters
Return Type
- IntrospectionResponse|Unauthorized|Forbidden - The
oauth2:IntrospectionResponseinstance or elseUnauthorizedorForbiddentype in case of an error
http: LoadBalanceClient
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
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe POST remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe PUT remote function implementation of the Load Balance Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe PATCH remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The HEAD remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe GET remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe OPTIONS remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, TargetType targetType) returns targetType|ClientErrorThe FORWARD remote function implementation of the LoadBalancer Connector.
Parameters
- path string - Resource path
- request Request - An HTTP request
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorThe submit implementation of the LoadBalancer Connector.
Parameters
- httpVerb string - The HTTP verb value. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorThe getResponse implementation of the LoadBalancer Connector.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanThe hasPromise implementation of the LoadBalancer Connector.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorThe getNextPromise implementation of the LoadBalancer Connector.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorThe getPromisedResponse implementation of the LoadBalancer Connector.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
function rejectPromise(PushPromise promise)The rejectPromise implementation of the LoadBalancer Connector.
Parameters
- promise PushPromise - The Push Promise to be rejected
post [PathParamType ...path]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe POST resource function implementation of the LoadBalancer Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe PUT resource function implementation of the LoadBalancer Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe PATCH resource function implementation of the LoadBalancer Connector.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe DELETE resource function implementation of the LoadBalancer Connector.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe HEAD resource function implementation of the LoadBalancer Connector.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe GET resource function implementation of the LoadBalancer Connector.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe OPTIONS resource function implementation of the LoadBalancer Connector.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
http: StatusCodeClient
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
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
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe Client.get() function can be used to send HTTP GET requests to HTTP endpoints.
Parameters
- path string - Request path
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- path string - Request path
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorInvokes 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
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorSubmits 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. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request or any allowed payload
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp: ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelates to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorPasses the request to an actual network call.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
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]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP POST requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PUT requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PATCH requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP DELETE requests to HTTP endpoints.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe client resource function to send HTTP HEAD requests to HTTP endpoints.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP GET requests to HTTP endpoints.
Parameters
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
getCookieStore
function getCookieStore() returns CookieStore?Retrieves the cookie store of the client.
Return Type
- CookieStore? - The cookie store related to the client
circuitBreakerForceClose
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
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
function getCircuitBreakerCurrentState() returns CircuitStateThe circuit breaker client related method to provides the http:CircuitState of the circuit breaker.
Return Type
- CircuitState - The current
http:CircuitStateof the circuit breaker
Service types
http: Service
The HTTP service type.
http: ServiceContract
The HTTP service contract type.
http: RequestInterceptor
The HTTP request interceptor service object type
http: ResponseInterceptor
The HTTP response interceptor service object type
http: RequestErrorInterceptor
The HTTP request error interceptor service object type
http: ResponseErrorInterceptor
The HTTP response error interceptor service object type
http: InterceptableService
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
HTTP header key age. Gives the current age of a cached HTTP response.
http: AUTH_HEADER
Represents the Authorization header name.
http: AUTH_SCHEME_BASIC
The prefix used to denote the Basic authentication scheme.
http: AUTH_SCHEME_BEARER
The prefix used to denote the Bearer authentication scheme.
http: AUTHORIZATION
HTTP header key authorization
http: CACHE_CONTROL
HTTP header key cache-control. Specifies the cache control directives required for the function of HTTP caches.
http: 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
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
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
Represents the open state of the circuit. When the Circuit Breaker is in OPEN state, requests will fail
immediately.
http: CHUNKING_ALWAYS
Always set chunking header in the response.
http: CHUNKING_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
Never set the chunking header even if the payload is larger than 8KB in the outbound request/response.
http: COMPRESSION_ALWAYS
Always set accept-encoding/content-encoding in outbound request/response.
http: COMPRESSION_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
Never set accept-encoding/content-encoding header in outbound request/response.
http: CONNECTION
HTTP header key connection. Allows the sender to specify options that are desired for that particular connection.
http: CONTENT_LENGTH
HTTP header key content-length. Specifies the size of the response body in bytes.
http: CONTENT_TYPE
HTTP header key content-type. Specifies the type of the message payload.
http: DATE
HTTP header key date. The timestamp at the time the response was generated/received.
http: DEFAULT_GRACEFULSTOP_TIMEOUT
Constant for the default listener gracefulStop timeout in seconds
http: DEFAULT_LISTENER_TIMEOUT
Constant for the default listener endpoint timeout in seconds
http: 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
HTTP header key expect. Specifies expectations to be fulfilled by the server.
http: EXPIRES
HTTP header key expires. Specifies the time at which the response becomes stale.
http: FAILED
Mutual SSL handshake has failed.
http: HTTP_DELETE
Constant for the HTTP DELETE method
http: HTTP_FORWARD
Constant for the HTTP FORWARD method
http: HTTP_GET
Constant for the HTTP GET method
http: HTTP_HEAD
Constant for the HTTP HEAD method
http: HTTP_NONE
Constant for the identify not an HTTP Operation
http: HTTP_OPTIONS
Constant for the HTTP OPTIONS method
http: HTTP_PATCH
Constant for the HTTP PATCH method
http: HTTP_POST
Constant for the HTTP POST method
http: HTTP_PUT
Constant for the HTTP PUT method
http: HTTP_SUBMIT
constant for the HTTP SUBMIT method
http: IF_MATCH
HTTP header key if-match
http: 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
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
HTTP header key if-range
http: IF_UNMODIFIED_SINCE
HTTP header key if-unmodified-since
http: JWT_INFORMATION
Constant to get the jwt information from the request context.
http: KEEPALIVE_ALWAYS
Keeps the connection alive irrespective of the connection header value }
http: KEEPALIVE_AUTO
Decides to keep the connection alive or not based on the connection header of the client request }
http: KEEPALIVE_NEVER
Closes the connection irrespective of the connection header value }
http: LAST_MODIFIED
HTTP header key last-modified. The time at which the resource was last modified.
http: LEADING
Header is placed before the payload of the request/response.
http: LOCATION
HTTP header key location. Indicates the URL to redirect a request to.
http: 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
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
Setting this as the max-stale directives indicates that the max-stale directive does not specify a limit.
http: MIN_FRESH
Indicates that the client is only accepting responses whose freshness lifetime >= current age + min-fresh.
http: MULTIPART_AS_PRIMARY_TYPE
Represents multipart primary type
http: 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
Forces the cache to validate a cached response with the origin server before serving.
http: NO_STORE
Instructs the cache to not store a response in non-volatile storage.
http: NO_TRANSFORM
Instructs intermediaries not to transform the payload.
http: NONE
Not a mutual ssl connection.
http: 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
Mutual SSL handshake is successful.
http: PRAGMA
HTTP header key pragma. Used in dealing with HTTP 1.0 caches which do not understand the cache-control header.
http: PRIVATE
Indicates that the response is intended for a single user and should not be stored by shared caches.
http: PROXY_AUTHORIZATION
HTTP header key proxy-authorization. Contains the credentials to authenticate a user agent to a proxy serve.
http: PROXY_REVALIDATE
Has the same semantics as must-revalidate, except that this does not apply to private caches.
http: PUBLIC
Indicates that any cache may store the response.
http: REDIRECT_FOUND_302
Represents the HTTP redirect status code 302 - Found.
http: REDIRECT_MOVED_PERMANENTLY_301
Represents the HTTP redirect status code 301 - Moved Permanently.
http: REDIRECT_MULTIPLE_CHOICES_300
Represents the HTTP redirect status code 300 - Multiple Choices.
http: REDIRECT_NOT_MODIFIED_304
Represents the HTTP redirect status code 304 - Not Modified.
http: REDIRECT_PERMANENT_REDIRECT_308
Represents the HTTP redirect status code 308 - Permanent Redirect.
http: REDIRECT_SEE_OTHER_303
Represents the HTTP redirect status code 303 - See Other.
http: REDIRECT_TEMPORARY_REDIRECT_307
Represents the HTTP redirect status code 307 - Temporary Redirect.
http: REDIRECT_USE_PROXY_305
Represents the HTTP redirect status code 305 - Use Proxy.
http: REQUEST_METHOD
Constant for the request method reference.
http: RESOURCE_NAME
Constant for the resource name reference.
http: RFC_7234
Caching behaviour is as specified by the RFC 7234 specification.
http: S_MAX_AGE
In shared caches, s-maxage overrides the max-age or expires header field.
http: SERVER
HTTP header key server. Specifies the details of the origin server.
http: SERVICE_NAME
Constant for the service name reference.
http: STATUS_ACCEPTED
The HTTP response status code: 202 Accepted
http: STATUS_ALREADY_REPORTED
The HTTP response status code: 208 Already Reported
http: STATUS_BAD_GATEWAY
The HTTP response status code: 502 Bad Gateway
http: STATUS_BAD_REQUEST
The HTTP response status code: 400 Bad Request
http: STATUS_CONFLICT
The HTTP response status code: 409 Conflict
http: STATUS_CONTINUE
The HTTP response status code: 100 Continue
http: STATUS_CREATED
The HTTP response status code: 201 Created
http: STATUS_EARLY_HINTS
The HTTP response status code: 103 Early Hints
http: STATUS_EXPECTATION_FAILED
The HTTP response status code: 417 Expectation Failed
http: STATUS_FAILED_DEPENDENCY
The HTTP response status code: 424 Failed Dependency
http: STATUS_FORBIDDEN
The HTTP response status code: 403 Forbidden
http: STATUS_FOUND
The HTTP response status code: 302 Found
http: STATUS_GATEWAY_TIMEOUT
The HTTP response status code: 504 Gateway Timeout
http: STATUS_GONE
The HTTP response status code: 410 Gone
http: STATUS_HTTP_VERSION_NOT_SUPPORTED
The HTTP response status code: 505 HTTP Version Not Supported
http: STATUS_IM_USED
The HTTP response status code: 226 IM Used
http: STATUS_INSUFFICIENT_STORAGE
The HTTP response status code: 507 Insufficient Storage
http: STATUS_INTERNAL_SERVER_ERROR
The HTTP response status code: 500 Internal Server Error
http: STATUS_LENGTH_REQUIRED
The HTTP response status code: 411 Length Required
http: STATUS_LOCKED
The HTTP response status code: 423 Locked
http: STATUS_LOOP_DETECTED
The HTTP response status code: 508 Loop Detected
http: STATUS_METHOD_NOT_ALLOWED
The HTTP response status code: 405 Method Not Allowed
http: STATUS_MISDIRECTED_REQUEST
The HTTP response status code: 421 Misdirected Request
http: STATUS_MOVED_PERMANENTLY
The HTTP response status code: 301 Moved Permanently
http: STATUS_MULTI_STATUS
The HTTP response status code: 207 Multi-Status
http: STATUS_MULTIPLE_CHOICES
The HTTP response status code: 300 Multiple Choices
http: STATUS_NETWORK_AUTHENTICATION_REQUIRED
The HTTP response status code: 511 Network Authorization Required
http: STATUS_NO_CONTENT
The HTTP response status code: 204 No Content
http: STATUS_NON_AUTHORITATIVE_INFORMATION
The HTTP response status code: 203 Non Authoritative Information
http: STATUS_NOT_ACCEPTABLE
The HTTP response status code: 406 Not Acceptable
http: STATUS_NOT_EXTENDED
The HTTP response status code: 510 Not Extended
http: STATUS_NOT_FOUND
The HTTP response status code: 404 Not Found
http: STATUS_NOT_IMPLEMENTED
The HTTP response status code: 501 Not Implemented
http: STATUS_NOT_MODIFIED
The HTTP response status code: 304 Not Modified
http: STATUS_OK
The HTTP response status code: 200 OK
http: STATUS_PARTIAL_CONTENT
The HTTP response status code: 206 Partial Content
http: STATUS_PAYLOAD_TOO_LARGE
The HTTP response status code: 413 Payload Too Large
http: STATUS_PAYMENT_REQUIRED
The HTTP response status code: 402 Payment Required
http: STATUS_PERMANENT_REDIRECT
The HTTP response status code: 308 Permanent Redirect
http: STATUS_PRECONDITION_FAILED
The HTTP response status code: 412 Precondition Failed
http: STATUS_PRECONDITION_REQUIRED
The HTTP response status code: 428 Precondition Required
http: STATUS_PROCESSING
The HTTP response status code: 102 Processing
http: STATUS_PROXY_AUTHENTICATION_REQUIRED
The HTTP response status code: 407 Proxy Authentication Required
http: STATUS_RANGE_NOT_SATISFIABLE
The HTTP response status code: 416 Range Not Satisfiable
http: STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE
The HTTP response status code: 431 Request Header Fields Too Large
http: STATUS_REQUEST_TIMEOUT
The HTTP response status code: 408 Request Timeout
http: STATUS_RESET_CONTENT
The HTTP response status code: 205 Reset Content
http: STATUS_SEE_OTHER
The HTTP response status code: 303 See Other
http: STATUS_SERVICE_UNAVAILABLE
The HTTP response status code: 503 Service Unavailable
http: STATUS_SWITCHING_PROTOCOLS
The HTTP response status code: 101 Switching Protocols
http: STATUS_TEMPORARY_REDIRECT
The HTTP response status code: 307 Temporary Redirect
http: STATUS_TOO_EARLY
The HTTP response status code: 425 Too Early
http: STATUS_TOO_MANY_REQUESTS
The HTTP response status code: 429 Too Many Requests
http: STATUS_UNAUTHORIZED
The HTTP response status code: 401 Unauthorized
http: STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS
The HTTP response status code: 451 Unavailable Due To Legal Reasons
http: STATUS_UNPROCESSABLE_ENTITY
The HTTP response status code: 422 Unprocessable Entity
http: STATUS_UNSUPPORTED_MEDIA_TYPE
The HTTP response status code: 415 Unsupported Media Type
http: STATUS_UPGRADE_REQUIRED
The HTTP response status code: 426 Upgrade Required
http: STATUS_URI_TOO_LONG
The HTTP response status code: 414 URI Too Long
http: STATUS_USE_PROXY
The HTTP response status code: 305 Use Proxy
http: STATUS_VARIANT_ALSO_NEGOTIATES
The HTTP response status code: 506 Variant Also Negotiates
http: TRAILING
Header is placed after the payload of the request/response.
http: TRANSFER_ENCODING
HTTP header key transfer-encoding. Specifies what type of transformation has been applied to entity body.
http: 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
HTTP header key warning. Specifies warnings generated when serving stale responses from HTTP caches.
Enums
http: CertValidationType
Represents certification validation type options.
Members
http: HttpVersion
Defines the supported HTTP protocols.
Members
http: Method
Represents HTTP methods.
Members
http: Protocol
Represents protocol options.
Members
http: VerifyClient
Represents client verify options.
Members
Variables
http: CONTINUE
The common status code response constant of Continue.
http: SWITCHING_PROTOCOLS
The common status code response constant of SwitchingProtocols.
http: PROCESSING
The common status code response constant of Processing.
http: EARLY_HINTS
The common status code response constant of EarlyHints.
http: OK
The common status code response constant of Ok.
http: CREATED
The common status code response constant of Created.
http: ACCEPTED
The common status code response constant of Accepted.
http: NON_AUTHORITATIVE_INFORMATION
The common status code response constant of NonAuthoritativeInformation.
http: NO_CONTENT
The common status code response constant of NoContent.
http: RESET_CONTENT
The common status code response constant of ResetContent.
http: PARTIAL_CONTENT
The common status code response constant of PartialContent.
http: MULTI_STATUS
The common status code response constant of MultiStatus.
http: ALREADY_REPORTED
The common status code response constant of AlreadyReported.
http: IM_USED
The common status code response constant of IMUsed.
http: MULTIPLE_CHOICES
The common status code response constant of MultipleChoices.
http: MOVED_PERMANENTLY
The common status code response constant of MovedPermanently.
http: FOUND
The common status code response constant of Found.
http: SEE_OTHER
The common status code response constant of SeeOther.
http: NOT_MODIFIED
The common status code response constant of NotModified.
http: USE_PROXY
The common status code response constant of UseProxy.
http: TEMPORARY_REDIRECT
The common status code response constant of TemporaryRedirect.
http: PERMANENT_REDIRECT
The common status code response constant of PermanentRedirect.
http: BAD_REQUEST
The common status code response constant of BadRequest.
http: UNAUTHORIZED
The common status code response constant of Unauthorized.
http: PAYMENT_REQUIRED
The common status code response constant of PaymentRequired.
http: FORBIDDEN
The common status code response constant of Forbidden.
http: NOT_FOUND
The common status code response constant of NotFound.
http: METHOD_NOT_ALLOWED
The common status code response constant of MethodNotAllowed.
http: NOT_ACCEPTABLE
The common status code response constant of NotAcceptable.
http: PROXY_AUTHENTICATION_REQUIRED
The common status code response constant of ProxyAuthenticationRequired.
http: REQUEST_TIMEOUT
The common status code response constant of RequestTimeout.
http: CONFLICT
The common status code response constant of Conflict.
http: GONE
The common status code response constant of Gone.
http: LENGTH_REQUIRED
The common status code response constant of LengthRequired.
http: PRECONDITION_FAILED
The common status code response constant of PreconditionFailed.
http: PAYLOAD_TOO_LARGE
The common status code response constant of PayloadTooLarge.
http: URI_TOO_LONG
The common status code response constant of UriTooLong.
http: UNSUPPORTED_MEDIA_TYPE
The common status code response constant of UnsupportedMediaType.
http: RANGE_NOT_SATISFIABLE
The common status code response constant of RangeNotSatisfiable.
http: EXPECTATION_FAILED
The common status code response constant of ExpectationFailed.
http: MISDIRECTED_REQUEST
The common status code response constant of MisdirectedRequest.
http: UNPROCESSABLE_ENTITY
The common status code response constant of UnprocessableEntity.
http: LOCKED
The common status code response constant of Locked.
http: FAILED_DEPENDENCY
The common status code response constant of FailedDependency.
http: TOO_EARLY
The common status code response constant of TooEarly.
http: PREDICTION_REQUIRED
The common status code response constant of PreconditionRequired.
http: UNAVAILABLE_DUE_TO_LEGAL_REASONS
The common status code response constant of UnavailableDueToLegalReasons.
http: UPGRADE_REQUIRED
The common status code response constant of UpgradeRequired.
http: TOO_MANY_REQUESTS
The common status code response constant of TooManyRequests.
http: REQUEST_HEADER_FIELDS_TOO_LARGE
The common status code response constant of RequestHeaderFieldsTooLarge.
http: INTERNAL_SERVER_ERROR
The common status code response constant of InternalServerError.
http: NOT_IMPLEMENTED
The common status code response constant of NotImplemented.
http: BAD_GATEWAY
The common status code response constant of BadGateway.
http: SERVICE_UNAVAILABLE
The common status code response constant of ServiceUnavailable.
http: GATEWAY_TIMEOUT
The common status code response constant of GatewayTimeout.
http: HTTP_VERSION_NOT_SUPPORTED
The common status code response constant of HttpVersionNotSupported.
http: VARIANT_ALSO_NEGOTIATES
The common status code response constant of VariantAlsoNegotiates.
http: INSUFFICIENT_STORAGE
The common status code response constant of InsufficientStorage.
http: LOOP_DETECTED
The common status code response constant of LoopDetected.
http: NOT_EXTENDED
The common status code response constant of NotExtended.
http: NETWORK_AUTHENTICATION_REQUIRED
The common status code response constant of NetworkAuthenticationRequired.
Listeners
http: Listener
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
Attaches a service to the listener.
Parameters
- httpService Service - The service that needs to be attached
Return Type
- error? - An
errorif an error occurred during the service attachment process or else()
'start
function 'start() returns error?Starts the registered service programmatically.
Return Type
- error? - An
errorif an error occurred during the listener starting process
gracefulStop
function gracefulStop() returns error?Stops the service listener gracefully. Already-accepted requests will be served before connection closure.
Return Type
- error? - An
errorif an error occurred during the listener stopping process
immediateStop
function immediateStop() returns error?Stops the service listener immediately. It is not implemented yet.
Return Type
- error? - An
errorif an error occurred during the listener stop process
detach
Detaches an HTTP service from the listener.
Parameters
- httpService Service - The service to be detached
Return Type
- error? - An
errorif one occurred during detaching of a service or else()
getPort
function getPort() returns intRetrieves the port of the HTTP listener.
Return Type
- int - The HTTP listener port
getConfig
function getConfig() returns readonly & InferredListenerConfigurationRetrieves the InferredListenerConfiguration of the HTTP listener.
Return Type
- readonly & InferredListenerConfiguration - The readonly HTTP listener inferred configuration
Annotations
http: Cache
returnThe 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
parameterThe annotation which is used to configure the type of the response.
http: Header
parameter, record fieldThe annotation which is used to define the Header parameter.
http: Payload
parameter, returnThe annotation which is used to define the Payload resource signature parameter and return parameter.
http: Query
parameter, record fieldThe annotation which is used to define the query parameter.
http: ResourceConfig
object functionThe annotation which is used to configure an HTTP resource.
http: ServiceConfig
service, typeThe annotation which is used to configure an HTTP service.
Configurables
http: traceLogConsole
http: traceLogAdvancedConfig
http: accessLogConfig
http: maxActiveConnections
http: maxIdleConnections
http: waitTime
http: maxActiveStreamsPerConnection
http: minEvictableIdleTime
http: timeBetweenEvictionRuns
http: minIdleTimeInStaleState
http: timeBetweenStaleEviction
http: defaultListenerPort
Default HTTP listener port used by the HTTP Default Listener. The default value is 9090.
http: defaultListenerConfig
Default HTTP listener configuration used by the HTTP Default Listener.
Records
http: Accepted
The status code response record of Accepted.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusAccepted(default STATUS_ACCEPTED_OBJ) - The response status code obj
http: AccessLogConfiguration
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
flatorjson)
- attributes? string[] - The list of attributes of access logs to be printed
- path? string - Optional file path to store access logs
http: AlreadyReported
The status code response record of AlreadyReported.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusAlreadyReported(default STATUS_ALREADY_REPORTED_OBJ) - The response status code obj
http: BadGateway
The status code response record of BadGateway.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusBadGateway(default STATUS_BAD_GATEWAY_OBJ) - The response status code obj
http: BadRequest
The status code response record of BadRequest.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusBadRequest(default STATUS_BAD_REQUEST_OBJ) - The response status code obj
http: BearerTokenConfig
Represents token for Bearer token authentication.
Fields
- token string - Bearer token for authentication
http: Bucket
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
Bucketis last updated.
http: CacheConfig
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.
- 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 thecache-controlheader and either theetagorlast-modifiedheader are present.
http: CertKey
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
Provides a set of configurations for controlling the behaviour of the Circuit Breaker.
Fields
- rollingWindow RollingWindow(default {}) - The
http:RollingWindowoptions of theCircuitBreaker
- 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
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:RollingWindowoptions provided in thehttp:CircuitBreakerConfig
http: CircuitHealth
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
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
- laxDataBinding boolean
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
http: ClientHttp1Settings
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
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
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:TrustStoreor single certificate file that the client trusts
- key? KeyStore|CertKey - Configurations associated with
crypto:KeyStoreor combination of certificate and private key of the client
- 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
- handshakeTimeout? decimal - SSL handshake time out
- sessionTimeout? decimal - SSL session time out
- serverName? string - Server name indication(SNI) to be used. If this is not present, hostname from the target URL will be used
http: ClientSocketConfig
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
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-forwardedheader
- 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
- 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
- laxDataBinding boolean(default false) - Enables or disables relaxed data binding on the client side. Disabled by default. When enabled, the JSON data will be projected to the Ballerina record type and during the projection, nil values will be considered as optional fields and absent fields will be considered for nilable types
http: CommonResponse
The common attributed of response status code record type.
Fields
- mediaType? string - The value of response
Content-typeheader
- body? anydata - The response payload
http: CompressionConfig
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
The status code response record of Conflict.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusConflict(default STATUS_CONFLICT_OBJ) - The response status code obj
http: Continue
The status code response record of Continue.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusContinue(default STATUS_CONTINUE_OBJ) - The response status code obj
http: CookieConfig
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
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
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
The status code response record of Created.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusCreated(default STATUS_CREATED_OBJ) - The response status code obj
http: CredentialsConfig
Represents credentials for Basic Auth authentication.
http: DefaultStatusCodeResponse
The default status code response record.
Fields
- Fields Included from *CommonResponse
- 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
- body anydata - The inbound error response body
http: EarlyHints
The status code response record of EarlyHints.
Fields
- Fields Included from *CommonResponse
- 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
The status code response record of ExpectationFailed.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusExpectationFailed(default STATUS_EXPECTATION_FAILED_OBJ) - The response status code obj
http: FailedDependency
The status code response record of FailedDependency.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusFailedDependency(default STATUS_FAILED_DEPENDENCY_OBJ) - The response status code obj
http: FailoverClientConfiguration
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
- laxDataBinding boolean
- 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
Represents file user store configurations for Basic Auth authentication.
http: FileUserStoreConfigWithScopes
Represents the auth annotation for file user store configurations with scopes.
Fields
- fileUserStoreConfig FileUserStoreConfig - File user store configurations for Basic Auth authentication
http: FollowRedirects
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
The status code response record of Forbidden.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusForbidden(default STATUS_FORBIDDEN_OBJ) - The response status code obj
http: Found
The status code response record of Found.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusFound(default STATUS_FOUND_OBJ) - The response status code obj
http: GatewayTimeout
The status code response record of GatewayTimeout.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusGatewayTimeout(default STATUS_GATEWAY_TIMEOUT_OBJ) - The response status code obj
http: Gone
The status code response record of Gone.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusGone(default STATUS_GONE_OBJ) - The response status code obj
http: HeaderValue
Represents the parsed header value details
Fields
- value string - The header value
http: HttpCacheConfig
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 last-modified headers are also added for cache validation.
Fields
- mustRevalidate boolean(default true) - Sets the
must-revalidatedirective
- noCache boolean(default false) - Sets the
no-cachedirective
- noStore boolean(default false) - Sets the
no-storedirective
- noTransform boolean(default false) - Sets the
no-transformdirective
- isPrivate boolean(default false) - Sets the
privateandpublicdirectives
- proxyRevalidate boolean(default false) - Sets the
proxy-revalidatedirective
- maxAge decimal(default 3600) - Sets the
max-agedirective. Default value is 3600 seconds
- sMaxAge decimal(default -1) - Sets the
s-maxagedirective
- noCacheFields string[](default []) - Optional fields for the
no-cachedirective. Before sending a listed field in a response, it must be validated with the origin server
- privateFields string[](default []) - Optional fields for the
privatedirective. A cache can omit the fields specified and store the rest of the response
- setETag boolean(default true) - Sets the
etagheader for the given payload
- setLastModified boolean(default true) - Sets the current time as the
last-modifiedheader
http: HttpCallerInfo
Configures the typing details type of the Caller resource signature parameter.
Fields
- respondType? typedesc<ResponseMessage|StatusCodeResponse|Error> - Specifies the type of response
http: HttpHeader
Defines the Header resource signature parameter.
Fields
- name? string - Specifies the name of the required header
http: HttpPayload
Defines the Payload resource signature parameter and return parameter.
Fields
http: HttpQuery
Defines the query resource signature parameter.
Fields
- name? string - Specifies the name of the query parameter
http: HttpResourceConfig
Configuration for an HTTP resource.
Fields
- name? string - The name of the resource
- consumes string[](default []) - The media types which are accepted by resource
- produces string[](default []) - The media types which are produced by resource
- cors CorsConfig(default {}) - The cross origin resource sharing configurations for the resource. If not set, the resource will inherit the CORS behaviour of the enclosing service.
- transactionInfectable boolean(default true) - Allow to participate in the distributed transactions if value is true
- auth? ListenerAuthConfig[]|Scopes - Resource auth configurations
- linkedTo? LinkedTo[] - The array of linked resources
http: HttpServiceConfig
Contains the configurations for an HTTP service.
Fields
- host string(default "b7a.default") - Domain name of the service
- compression CompressionConfig(default {}) - The status of compression
- chunking Chunking(default CHUNKING_AUTO) - Configures the chunking behaviour for the service
- cors CorsConfig(default {}) - The cross origin resource sharing configurations for the service
- auth? ListenerAuthConfig[] - Service auth configurations
- mediaTypeSubtypePrefix? string - Service specific media-type subtype prefix
- treatNilableAsOptional boolean(default true) - Treat Nilable parameters as optional
- openApiDefinition byte[](default []) - The generated OpenAPI definition for the HTTP service. This is auto-generated at compile-time if OpenAPI doc auto generation is enabled
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- serviceType? typedesc<ServiceContract> - The service object type which defines the service contract. This is auto-generated at compile-time
- basePath? string - Base path to be used with the service implementation. This is only allowed on service contract types
- laxDataBinding boolean(default false) - Enables or disables relaxed data binding on the service side. Disabled by default. When enabled, the JSON data will be projected to the Ballerina record type and during the projection, nil values will be considered as optional fields and absent fields will be considered for nilable types
http: HttpVersionNotSupported
The status code response record of HttpVersionNotSupported.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusHttpVersionNotSupported(default STATUS_HTTP_VERSION_NOT_SUPPORTED_OBJ) - The response status code obj
http: IMUsed
The status code response record of IMUsed.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusIMUsed(default STATUS_IM_USED_OBJ) - The response status code obj
http: InferredListenerConfiguration
Provides a set of cloneable configurations for HTTP listener.
Fields
- host string - The host name/IP of the endpoint
- http1Settings ListenerHttp1Settings - Configurations related to HTTP/1.x protocol
- secureSocket ListenerSecureSocket? - The SSL configurations for the service endpoint. This needs to be configured in order to communicate through HTTPS.
- httpVersion HttpVersion - Highest HTTP version supported by the endpoint
- timeout decimal - Period of time in seconds that a connection waits for a read/write operation. Use value 0 to disable timeout
- server string? - The server name which should appear as a response header
- requestLimits RequestLimitConfigs - Configurations associated with inbound request size limits
http: InsufficientStorage
The status code response record of InsufficientStorage.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusInsufficientStorage(default STATUS_INSUFFICIENT_STORAGE_OBJ) - The response status code obj
http: InternalServerError
The status code response record of InternalServerError.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusInternalServerError(default STATUS_INTERNAL_SERVER_ERROR_OBJ) - The response status code obj
http: JwtIssuerConfig
Represents JWT issuer configurations for JWT authentication.
http: JwtValidatorConfig
Represents JWT validator configurations for JWT authentication.
Fields
- scopeKey string(default "scope") - The key used to fetch the scopes
http: JwtValidatorConfigWithScopes
Represents the auth annotation for JWT validator configurations with scopes.
Fields
- jwtValidatorConfig JwtValidatorConfig - JWT validator configurations for JWT authentication
http: LdapUserStoreConfig
Represents LDAP user store configurations for Basic Auth authentication.
http: LdapUserStoreConfigWithScopes
Represents the auth annotation for LDAP user store configurations with scopes.
Fields
- ldapUserStoreConfig LdapUserStoreConfig - LDAP user store configurations for Basic Auth authentication
http: LengthRequired
The status code response record of LengthRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusLengthRequired(default STATUS_LENGTH_REQUIRED_OBJ) - The response status code obj
http: Link
Represents a server-provided hyperlink
Fields
- rel? string - Names the relationship of the linked target to the current representation
- href string - Target URL
- types? string[] - Expected resource representation media types
- methods? Method[] - Allowed resource methods
http: LinkedTo
Fields
- name string - Name of the linked resource
- relation string(default "self") - Name of the relationship between the linked resource and the current resource.
Defaulted to the IANA link relation
self
- method? string - Method allowed in the linked resource
http: Links
Represents available server-provided links
Fields
http: ListenerConfiguration
Provides a set of configurations for HTTP service endpoints.
Fields
- host string(default "0.0.0.0") - The host name/IP of the endpoint
- http1Settings ListenerHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- secureSocket ListenerSecureSocket?(default ()) - The SSL configurations for the service endpoint. This needs to be configured in order to communicate through HTTPS.
- httpVersion HttpVersion(default HTTP_2_0) - Highest HTTP version supported by the endpoint
- timeout decimal(default DEFAULT_LISTENER_TIMEOUT) - Period of time in seconds that a connection waits for a read/write operation. Use value 0 to disable timeout
- server string?(default ()) - The server name which should appear as a response header
- requestLimits RequestLimitConfigs(default {}) - Configurations associated with inbound request size limits
- gracefulStopTimeout decimal(default DEFAULT_GRACEFULSTOP_TIMEOUT) - Grace period of time in seconds for listener gracefulStop
- socketConfig ServerSocketConfig(default {}) - Provides settings related to server socket configuration
- http2InitialWindowSize int(default 65535) - Configuration to change the initial window size in HTTP/2
- minIdleTimeInStaleState decimal(default 300) - Minimum time in seconds for a connection to be kept open which has received a GOAWAY. This only applies for HTTP/2. Default value is 5 minutes. If the value is set to -1, the connection will be closed after all in-flight streams are completed
- timeBetweenStaleEviction decimal(default 30) - Time between the connection stale eviction runs in seconds. This only applies for HTTP/2. Default value is 30 seconds
http: ListenerHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default KEEPALIVE_AUTO) - Can be set to either
KEEPALIVE_AUTO, which respects theconnectionheader, orKEEPALIVE_ALWAYS, which always keeps the connection alive, orKEEPALIVE_NEVER, which always closes the connection
- maxPipelinedRequests int(default MAX_PIPELINED_REQUESTS) - Defines the maximum number of requests that can be processed at a given time on a single connection. By default 10 requests can be pipelined on a single connection and user can change this limit appropriately.
http: ListenerSecureSocket
Configures the SSL/TLS options to be used for HTTP service.
Fields
- key KeyStore|CertKey - Configurations associated with
crypto:KeyStoreor combination of certificate and (PKCS8) private key of the server
- mutualSsl? record {| verifyClient VerifyClient, cert TrustStore|string |} - Configures associated with mutual SSL operations
- certValidation? record {| 'type CertValidationType, cacheSize int, cacheValidityPeriod int |} - Certificate validation against OCSP_CRL, OCSP_STAPLING related options
- ciphers string[](default ["TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256"]) - List of ciphers to be used eg: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- handshakeTimeout? decimal - SSL handshake time out
- sessionTimeout? decimal - SSL session time out
http: LoadBalanceActionErrorData
Represents the details of the LoadBalanceActionError.
Fields
- httpActionErr? error[] - Array of errors occurred at each endpoint
http: LoadBalanceClientConfiguration
The configurations related to the load balancing client endpoint. The following fields are inherited from the other configuration records in addition to the load balancing 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
- laxDataBinding boolean
- targets TargetService[](default []) - The upstream HTTP endpoints among which the incoming HTTP traffic load should be distributed
- lbRule LoadBalancerRule?(default ()) - The
LoadBalancingrule
- failover boolean(default true) - Configuration for the load balancer whether to fail over a failure
http: Local
Presents a read-only view of the local address.
Fields
- host string - The local host name
- port int - The local port
- ip string - The local IP address
http: Locked
The status code response record of Locked.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusLocked(default STATUS_LOCKED_OBJ) - The response status code obj
http: LoopDetected
The status code response record of LoopDetected.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusLoopDetected(default STATUS_LOOP_DETECTED_OBJ) - The response status code obj
http: MethodNotAllowed
The status code response record of MethodNotAllowed.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusMethodNotAllowed(default STATUS_METHOD_NOT_ALLOWED_OBJ) - The response status code obj
http: MisdirectedRequest
The status code response record of MisdirectedRequest.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusMisdirectedRequest(default STATUS_MISDIRECTED_REQUEST_OBJ) - The response status code obj
http: MovedPermanently
The status code response record of MovedPermanently.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusMovedPermanently(default STATUS_MOVED_PERMANENTLY_OBJ) - The response status code obj
http: MultipleChoices
The status code response record of MultipleChoices.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusMultipleChoices(default STATUS_MULTIPLE_CHOICES_OBJ) - The response status code obj
http: MultiStatus
The status code response record of MultiStatus.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusMultiStatus(default STATUS_MULTI_STATUS_OBJ) - The response status code obj
http: MutualSslHandshake
A record for providing mutual SSL handshake results.
Fields
- status MutualSslStatus(default ()) - Status of the handshake.
- base64EncodedCert string?(default ()) - Base64 encoded certificate.
http: NetworkAuthenticationRequired
The status code response record of NetworkAuthenticationRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNetworkAuthenticationRequired(default STATUS_NETWORK_AUTHENTICATION_REQUIRED_OBJ) - The response status code obj
http: NetworkAuthorizationRequired
The status code response record of NetworkAuthorizationRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNetworkAuthenticationRequired(default StatusNetworkAuthenticationRequired) - The response status code obj
Deprecated
This record is deprecated. Please useNetworkAuthenticationRequiredinstead.
Deprecated
This record is deprecated. Please use NetworkAuthenticationRequired instead.
http: NoContent
The status code response record of NoContent.
Fields
- statusreadonly StatusNoContent(default STATUS_NO_CONTENT_OBJ) - The response status code obj
http: NonAuthoritativeInformation
The status code response record of NonAuthoritativeInformation.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNonAuthoritativeInformation(default STATUS_NON_AUTHORITATIVE_INFORMATION_OBJ) - The response status code obj
http: NotAcceptable
The status code response record of NotAcceptable.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNotAcceptable(default STATUS_NOT_ACCEPTABLE_OBJ) - The response status code obj
http: NotExtended
The status code response record of NotExtended.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNotExtended(default STATUS_NOT_EXTENDED_OBJ) - The response status code obj
http: NotFound
The status code response record of NotFound.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNotFound(default STATUS_NOT_FOUND_OBJ) - The response status code obj
http: NotImplemented
The status code response record of NotImplemented.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNotImplemented(default STATUS_NOT_IMPLEMENTED_OBJ) - The response status code obj
http: NotModified
The status code response record of NotModified.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusNotModified(default STATUS_NOT_MODIFIED_OBJ) - The response status code obj
http: OAuth2ClientCredentialsGrantConfig
Represents OAuth2 client credentials grant configurations for OAuth2 authentication.
http: OAuth2IntrospectionConfig
Represents OAuth2 introspection server configurations for OAuth2 authentication.
Fields
- scopeKey string(default "scope") - The key used to fetch the scopes
http: OAuth2IntrospectionConfigWithScopes
Represents the auth annotation for OAuth2 introspection server configurations with scopes.
Fields
- oauth2IntrospectionConfig OAuth2IntrospectionConfig - OAuth2 introspection server configurations for OAuth2 authentication
http: OAuth2JwtBearerGrantConfig
Represents OAuth2 JWT bearer grant configurations for OAuth2 authentication.
http: OAuth2PasswordGrantConfig
Represents OAuth2 password grant configurations for OAuth2 authentication.
http: OAuth2RefreshTokenGrantConfig
Represents OAuth2 refresh token grant configurations for OAuth2 authentication.
http: Ok
The status code response record of Ok.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusOK(default STATUS_OK_OBJ) - The response status code obj
http: PartialContent
The status code response record of PartialContent.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPartialContent(default STATUS_PARTIAL_CONTENT_OBJ) - The response status code obj
http: PayloadTooLarge
The status code response record of PayloadTooLarge.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPayloadTooLarge(default STATUS_PAYLOAD_TOO_LARGE_OBJ) - The response status code obj
http: PaymentRequired
The status code response record of PaymentRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPaymentRequired(default STATUS_PAYMENT_REQUIRED_OBJ) - The response status code obj
http: PermanentRedirect
The status code response record of PermanentRedirect.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPermanentRedirect(default STATUS_PERMANENT_REDIRECT_OBJ) - The response status code obj
http: PoolConfiguration
Configurations for managing HTTP client connection pool.
Fields
- maxActiveConnections int(default maxActiveConnections) - Max active connections per route(host:port). Default value is -1 which indicates unlimited.
- maxIdleConnections int(default maxIdleConnections) - Maximum number of idle connections allowed per pool.
- waitTime decimal(default waitTime) - Maximum amount of time (in seconds), the client should wait for an idle connection before it sends an error when the pool is exhausted
- maxActiveStreamsPerConnection int(default maxActiveStreamsPerConnection) - Maximum active streams per connection. This only applies to HTTP/2. Default value is 100
- minEvictableIdleTime decimal(default minEvictableIdleTime) - Minimum evictable time for an idle connection in seconds. Default value is 5 minutes
- timeBetweenEvictionRuns decimal(default timeBetweenEvictionRuns) - Time between eviction runs in seconds. Default value is 30 seconds
- minIdleTimeInStaleState decimal(default minIdleTimeInStaleState) - Minimum time in seconds for a connection to be kept open which has received a GOAWAY. This only applies for HTTP/2. Default value is 5 minutes. If the value is set to -1, the connection will be closed after all in-flight streams are completed
- timeBetweenStaleEviction decimal(default timeBetweenStaleEviction) - Time between the connection stale eviction runs in seconds. This only applies for HTTP/2. Default value is 30 seconds
http: PreconditionFailed
The status code response record of PreconditionFailed.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPreconditionFailed(default STATUS_PRECONDITION_FAILED_OBJ) - The response status code obj
http: PreconditionRequired
The status code response record of PreconditionRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusPreconditionRequired(default STATUS_PRECONDITION_REQUIRED_OBJ) - The response status code obj
http: Processing
The status code response record of Processing.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusProcessing(default STATUS_PROCESSING_OBJ) - The response status code obj
http: ProxyAuthenticationRequired
The status code response record of ProxyAuthenticationRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusProxyAuthenticationRequired(default STATUS_PROXY_AUTHENTICATION_REQUIRED_OBJ) - The response status code obj
http: ProxyConfig
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - proxy server password
http: QueryParams
Defines the record type of query parameters supported with client resource methods.
Fields
- headers? never - headers which cannot be used as a query field
- targetType? never - targetType which cannot be used as a query field
- message? never - message which cannot be used as a query field
- mediaType? never - mediaType which cannot be used as a query field
- QueryParamType... - Rest field
http: RangeNotSatisfiable
The status code response record of RangeNotSatisfiable.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusRangeNotSatisfiable(default STATUS_RANGE_NOT_SATISFIABLE_OBJ) - The response status code obj
http: Remote
Presents a read-only view of the remote address.
Fields
- host string - The remote host name
- port int - The remote port
- ip string - The remote IP address
http: RequestHeaderFieldsTooLarge
The status code response record of RequestHeaderFieldsTooLarge.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusRequestHeaderFieldsTooLarge(default STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE_OBJ) - The response status code obj
http: RequestLimitConfigs
Provides inbound request URI, total header and entity body size threshold configurations.
Fields
- maxUriLength int(default 4096) - Maximum allowed length for a URI. Exceeding this limit will result in a
414 - URI Too Longresponse. For HTTP/2, this limit will not be applicable as it already has a:pathpseudo-header which will be validated bymaxHeaderSize
- maxHeaderSize int(default 8192) - Maximum allowed size for headers. Exceeding this limit will result in a
431 - Request Header Fields Too Largeresponse
- maxEntityBodySize int(default -1) - Maximum allowed size for the entity body. By default it is set to -1 which means there
is no restriction
maxEntityBodySize, On the Exceeding this limit will result in a413 - Payload Too Largeresponse
http: RequestTimeout
The status code response record of RequestTimeout.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusRequestTimeout(default STATUS_REQUEST_TIMEOUT_OBJ) - The response status code obj
http: ResetContent
The status code response record of ResetContent.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusResetContent(default STATUS_RESET_CONTENT_OBJ) - The response status code obj
http: ResponseLimitConfigs
Provides inbound response status line, total header and entity body size threshold configurations.
Fields
- maxStatusLineLength int(default 4096) - Maximum allowed length for response status line(
HTTP/1.1 200 OK). Exceeding this limit will result in aClientError
- maxHeaderSize int(default 8192) - Maximum allowed size for headers. Exceeding this limit will result in a
ClientError
- maxEntityBodySize int(default -1) - Maximum allowed size for the entity body. By default it is set to -1 which means there is no
restriction
maxEntityBodySize, On the Exceeding this limit will result in aClientError
http: RetryConfig
Provides configurations for controlling the retrying behavior in failure scenarios.
Fields
- count int(default 0) - Number of retry attempts before giving up
- interval decimal(default 0) - Retry interval in seconds
- backOffFactor float(default 0.0) - Multiplier, which increases the retry interval exponentially.
- maxWaitInterval decimal(default 0) - Maximum time of the retry interval in seconds
- statusCodes int[](default []) - HTTP response status codes which are considered as failures
http: RollingWindow
Represents a rolling window in the Circuit Breaker.
Fields
- requestVolumeThreshold int(default 10) - Minimum number of requests in a
RollingWindowthat will trip the circuit.
- timeWindow decimal(default 60) - Time period in seconds for which the failure threshold is calculated
- bucketSize decimal(default 10) - The granularity at which the time window slides. This is measured in seconds.
http: Scopes
Represents the annotation used for authorization.
Fields
http: SeeOther
The status code response record of SeeOther.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusSeeOther(default STATUS_SEE_OTHER_OBJ) - The response status code obj
http: ServerSocketConfig
Provides settings related to server socket configuration.
Fields
- Fields Included from *ClientSocketConfig
- soBackLog int(default 100) - Requested maximum length of the queue of incoming connections.
http: ServiceUnavailable
The status code response record of ServiceUnavailable.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusServiceUnavailable(default STATUS_SERVICE_UNAVAILABLE_OBJ) - The response status code obj
http: SseEvent
Represents a Server Sent Event emitted from a service.
Fields
- event? string - Name of the event
- id? string - Id of the event
- data? string - Data part of the event
- 'retry? int - The reconnect time on failure in milliseconds.
- comment? string - Comment added to the event
http: StatusCodeBindingErrorDetail
Represents the details of an HTTP status code binding client error.
Fields
- Fields Included from *Detail
- fromDefaultStatusCodeMapping boolean - Indicates whether the error orginates from default status code response mapping
http: SwitchingProtocols
The status code response record of SwitchingProtocols.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusSwitchingProtocols(default STATUS_SWITCHING_PROTOCOLS_OBJ) - The response status code obj
http: TargetService
Represents a single service and its related configurations.
Fields
- url string(default "") - URL of the target service
- secureSocket ClientSecureSocket?(default ()) - Configurations for secure communication with the remote HTTP endpoint
http: TemporaryRedirect
The status code response record of TemporaryRedirect.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusTemporaryRedirect(default STATUS_TEMPORARY_REDIRECT_OBJ) - The response status code obj
http: TooEarly
The status code response record of TooEarly.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusTooEarly(default STATUS_TOO_EARLY_OBJ) - The response status code obj
http: TooManyRequests
The status code response record of TooManyRequests.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusTooManyRequests(default STATUS_TOO_MANY_REQUESTS_OBJ) - The response status code obj
http: TraceLogAdvancedConfiguration
Represents HTTP trace log configuration.
Fields
- console boolean(default false) - Boolean value to enable or disable console trace logs
- path? string - Optional file path to store trace logs
- host? string - Optional socket hostname to publish the trace logs
- port? int - Optional socket port to publish the trace logs
http: Unauthorized
The status code response record of Unauthorized.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUnauthorized(default STATUS_UNAUTHORIZED_OBJ) - The response status code obj
http: UnavailableDueToLegalReasons
The status code response record of UnavailableDueToLegalReasons.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUnavailableDueToLegalReasons(default STATUS_UNAVAILABLE_DUE_TO_LEGAL_REASONS_OBJ) - The response status code obj
http: UnprocessableEntity
The status code response record of UnprocessableEntity.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUnprocessableEntity(default STATUS_UNPROCESSABLE_ENTITY_OBJ) - The response status code obj
http: UnsupportedMediaType
The status code response record of UnsupportedMediaType.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUnsupportedMediaType(default STATUS_UNSUPPORTED_MEDIA_TYPE_OBJ) - The response status code obj
http: UpgradeRequired
The status code response record of UpgradeRequired.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUpgradeRequired(default STATUS_UPGRADE_REQUIRED_OBJ) - The response status code obj
http: UriTooLong
The status code response record of UriTooLong.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUriTooLong(default STATUS_URI_TOO_LONG_OBJ) - The response status code obj
http: UseProxy
The status code response record of UseProxy.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusUseProxy(default STATUS_USE_PROXY_OBJ) - The response status code obj
http: VariantAlsoNegotiates
The status code response record of VariantAlsoNegotiates.
Fields
- Fields Included from *CommonResponse
- statusreadonly StatusVariantAlsoNegotiates(default STATUS_VARIANT_ALSO_NEGOTIATES_OBJ) - The response status code obj
Errors
http: AllLoadBalanceEndpointsFailedError
Represents a client error that occurred due to all the load balance endpoint failure.
http: AllRetryAttemptsFailed
Represents a client error that occurred due to all the the retry attempts failure.
http: ApplicationResponseError
Represents both 4XX and 5XX application response client error.
http: CircuitBreakerConfigError
Represents a client error that occurred due to circuit breaker configuration error.
http: ClientAuthError
Defines the Auth error types that returned from client.
http: ClientConnectorError
Represents a client connector error that occurred.
http: ClientError
Defines the possible client error types.
http: ClientRequestError
Represents an error, which occurred due to bad syntax or incomplete info in the client request(4xx HTTP response).
http: CookieHandlingError
Represents a cookie error that occurred when using the cookies.
http: Error
Defines the common error type for the module.
http: FailoverActionFailedError
Represents a client error that occurred due to failover action failure.
http: FailoverAllEndpointsFailedError
Represents a client error that occurred due to all the failover endpoint failure.
http: GenericClientError
Represents a generic client error.
http: GenericListenerError
Represents a generic listener error.
http: HeaderBindingError
Represents an error, which occurred due to header binding.
http: HeaderNotFoundError
Represents a header not found error when retrieving headers.
http: HeaderValidationError
Represents an error, which occurred due to a header constraint validation.
http: Http2ClientError
Represents an HTTP/2 client generic error.
http: IdleTimeoutError
Represents the error that triggered upon a request/response idle timeout.
http: InboundRequestError
Defines the listener error types that returned while receiving inbound request.
http: InboundResponseError
Defines the client error types that returned while receiving inbound response.
http: InitializingInboundRequestError
Represents a listener error that occurred due to inbound request initialization failure.
http: InitializingInboundResponseError
Represents a client error that occurred due to inbound response initialization failure.
http: InitializingOutboundRequestError
Represents a client error that occurred due to outbound request initialization failure.
http: InitializingOutboundResponseError
Represents a listener error that occurred due to outbound response initialization failure.
http: Initiating100ContinueResponseError
Represents an error that occurred due to 100 continue response initialization failure.
http: InvalidCookieError
Represents a cookie error that occurred when sending cookies in the response.
http: ListenerAuthError
Defines the auth error types that returned from listener.
http: ListenerError
Defines the possible listener error types.
http: MaximumWaitTimeExceededError
Represents a client error that occurred exceeding maximum wait time.
http: MediaTypeBindingError
Represents an error, which occurred due to media-type binding.
http: MediaTypeValidationError
Represents an error, which occurred due to media type validation.
http: NoContentError
Represents an error, which occurred due to the absence of the payload.
http: OutboundRequestError
Defines the client error types that returned while sending outbound request.
http: OutboundResponseError
Defines the listener error types that returned while sending outbound response.
http: PayloadBindingError
Represents an error, which occurred due to payload binding.
http: PayloadValidationError
Represents an error, which occurred due to payload constraint validation.
http: QueryParameterValidationError
Represents an error, which occurred due to a query parameter constraint validation.
http: ReadingInboundRequestBodyError
Represents a listener error that occurred while writing the inbound request entity body.
http: ReadingInboundRequestHeadersError
Represents a listener error that occurred while reading inbound request headers.
http: ReadingInboundResponseBodyError
Represents a client error that occurred while reading inbound response entity body.
http: ReadingInboundResponseHeadersError
Represents a client error that occurred while reading inbound response headers.
http: RemoteServerError
Represents an error, which occurred due to a failure of the remote server(5xx HTTP response).
http: RequestDispatchingError
Represents an error, which occurred during the request dispatching.
http: ResiliencyError
Defines the resiliency error types that returned from client.
http: ResourceDispatchingError
Represents an error, which occurred during the resource dispatching.
http: ServiceDispatchingError
Represents an error, which occurred during the service dispatching.
http: SslError
Represents a client error that occurred due to SSL failure.
http: StatusCodeResponseDataBindingError
Represents the client status code response data binding error
http: UnsupportedActionError
Represents a client error that occurred due to unsupported action invocation.
http: UpstreamServiceUnavailableError
Represents a client error that occurred due to upstream service unavailability.
http: Writing100ContinueResponseError
Represents an error that occurred while writing 100 continue response.
http: WritingOutboundRequestBodyError
Represents a client error that occurred while writing outbound request entity body.
http: WritingOutboundRequestHeadersError
Represents a client error that occurred while writing outbound request headers.
http: WritingOutboundResponseBodyError
Represents a listener error that occurred while writing outbound response entity body.
http: WritingOutboundResponseHeadersError
Represents a listener error that occurred while writing outbound response headers.
Object types
http: ClientObject
The representation of the http Client object type for managing resilient clients.
post [PathParamType ...path]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP POST requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PUT requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PATCH requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP DELETE requests to HTTP endpoints.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe client resource function to send HTTP HEAD requests to HTTP endpoints.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP GET requests to HTTP endpoints.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, TargetType targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- targetType TargetType (default <>) - HTTP response,
anydataor 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
post
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe Client.get() function can be used to send HTTP GET requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, TargetType targetType) returns targetType|ClientErrorThe Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, TargetType targetType) returns targetType|ClientErrorInvokes 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType TargetType (default <>) - HTTP response,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, TargetType targetType) returns targetType|ClientErrorThe 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,
anydataor stream of HTTP SSE, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorSubmits 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. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request message or any payload of type
string,xml,json,byte[]ormime:Entity[]
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp: ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelates to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorPasses the request to an actual network call.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
function rejectPromise(PushPromise promise)This just pass the request to actual network call.
Parameters
- promise PushPromise - The Push Promise to be rejected
http: LoadBalancerRule
LoadBalancerRule object type provides a required abstraction to implement different algorithms.
getNextClient
function getNextClient(Client?[] loadBalanceCallerActionsArray) returns Client|ClientErrorProvides an HTTP client which is chosen according to the algorithm.
Parameters
- loadBalanceCallerActionsArray Client?[] - Array of HTTP clients which needs to be load balanced
Return Type
- Client|ClientError - Chosen
Clientfrom the algorithm or anhttp:ClientErrorfor the failure in the algorithm implementation
http: PersistentCookieHandler
The representation of a persistent cookie handler object type for managing persistent cookies.
storeCookie
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
http:CookieHandlingErrorif there is any error occurred during the storing process of the cookie or else()
getAllCookies
function getAllCookies() returns Cookie[]|CookieHandlingErrorGets all persistent cookies.
Return Type
- Cookie[]|CookieHandlingError - Array of persistent cookies stored in the cookie store or else an
http:CookieHandlingErrorif one occurred during the retrieval of the cookies
removeCookie
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
http:CookieHandlingErrorif there is one occurred during the removal of the cookie or else()
removeAllCookies
function removeAllCookies() returns CookieHandlingError?Removes all persistent cookies.
Return Type
- CookieHandlingError? - An
http:CookieHandlingErrorif there is one occurred during the removal of all the cookies or else()
http: Status
The Status object creates the distinction for the different response status code types.
Fields
- code int - The response status code
http: StatusCodeClientObject
The representation of the http Status Code Client object type for managing resilient clients.
post [PathParamType ...path]
function post [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP POST requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put [PathParamType ...path]
function put [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PUT requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch [PathParamType ...path]
function patch [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP PATCH requests to HTTP endpoints.
Parameters
- message RequestMessage - An HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete [PathParamType ...path]
function delete [PathParamType ...path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP DELETE requests to HTTP endpoints.
Parameters
- message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head [PathParamType ...path]
function head [PathParamType ...path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientErrorThe client resource function to send HTTP HEAD requests to HTTP endpoints.
Parameters
- params *QueryParams - The query parameters
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get [PathParamType ...path]
function get [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP GET requests to HTTP endpoints.
Parameters
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options [PathParamType ...path]
function options [PathParamType ...path](map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType, *QueryParams params) returns targetType|ClientErrorThe client resource function to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, 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
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
post
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
put
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
patch
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
delete
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
head
The Client.head() function can be used to send HTTP HEAD requests to HTTP endpoints.
Parameters
- path string - Resource path
Return Type
- Response|ClientError - The response or an
http:ClientErrorif failed to establish the communication with the upstream server
get
function get(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe Client.get() function can be used to send HTTP GET requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
options
function options(string path, map<string|string[]>? headers, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe Client.options() function can be used to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- path string - Request path
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
execute
function execute(string httpVerb, string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorInvokes 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
- mediaType string? (default ()) - The MIME type header of the request entity
- targetType typedesc<StatusCodeResponse> (default <>) - HTTP response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
forward
function forward(string path, Request request, typedesc<StatusCodeResponse> targetType) returns targetType|ClientErrorThe 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 response or
anydata, which is expected to be returned after data binding
Return Type
- targetType|ClientError - The response or the payload (if the
targetTypeis configured) or anhttp:ClientErrorif failed to establish the communication with the upstream server or a data binding failure
submit
function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture|ClientErrorSubmits 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. The HTTP verb is case-sensitive. Use the
http:Methodtype to specify the the standard HTTP methods.
- path string - The resource path
- message RequestMessage - An HTTP outbound request message or any payload of type
string,xml,json,byte[]ormime:Entity[]
Return Type
- HttpFuture|ClientError - An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
getResponse
function getResponse(HttpFuture httpFuture) returns Response|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- Response|ClientError - An
http:Responsemessage or else anhttp: ClientErrorif the invocation fails
hasPromise
function hasPromise(HttpFuture httpFuture) returns booleanThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelates to a previous asynchronous invocation
Return Type
- boolean - A
boolean, which represents whether anhttp:PushPromiseexists
getNextPromise
function getNextPromise(HttpFuture httpFuture) returns PushPromise|ClientErrorThis just pass the request to actual network call.
Parameters
- httpFuture HttpFuture - The
http:HttpFuturerelated to a previous asynchronous invocation
Return Type
- PushPromise|ClientError - An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
getPromisedResponse
function getPromisedResponse(PushPromise promise) returns Response|ClientErrorPasses the request to an actual network call.
Parameters
- promise PushPromise - The related
http:PushPromise
Return Type
- Response|ClientError - A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
rejectPromise
function rejectPromise(PushPromise promise)This just pass the request to actual network call.
Parameters
- promise PushPromise - The Push Promise to be rejected
Union types
http: CachingPolicy
CachingPolicy
Used for configuring the caching behaviour. Setting the policy field in the CacheConfig record allows
the user to control the caching behaviour.
http: RequestMessage
RequestMessage
The types of messages that are accepted by HTTP client when sending out the outbound request.
http: ResponseMessage
ResponseMessage
The types of messages that are accepted by HTTP listener when sending out the outbound response.
http: HttpOperation
HttpOperation
Defines the HTTP operations related to circuit breaker, failover and load balancer.
FORWARD: Forward the specified payload
GET: Request a resource
POST: Create a new resource
DELETE: Deletes the specified resource
OPTIONS: Request communication options available
PUT: Replace the target resource
PATCH: Apply partial modification to the resource
HEAD: Identical to GET but no resource body should be returned
SUBMIT: Submits a http request and returns an HttpFuture object
NONE: No operation should be performed
http: KeepAlive
KeepAlive
Defines the possible values for the keep-alive configuration in service and client endpoints.
http: MutualSslStatus
MutualSslStatus
Defines the possible values for the mutual ssl status.
passed: Mutual SSL handshake is successful.
failed: Mutual SSL handshake has failed.
http: RedirectCode
RedirectCode
Defines the HTTP redirect codes as a type.
http: CircuitState
CircuitState
A finite type for modeling the states of the Circuit Breaker. The Circuit Breaker starts in the CLOSED state.
If any failure thresholds are exceeded during execution, the circuit trips and goes to the OPEN state. After
the specified timeout period expires, the circuit goes to the HALF_OPEN state. If the trial request sent while
in the HALF_OPEN state succeeds, the circuit goes back to the CLOSED state.
http: Chunking
Chunking
Defines the possible values for the chunking configuration in HTTP services and clients.
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
ALWAYS: Always set chunking header in the response
NEVER: Never set the chunking header even if the payload is larger than 8KB in the outbound request/response
http: Compression
Compression
Options to compress using gzip or deflate.
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
ALWAYS: Always set accept-encoding/content-encoding in outbound request/response
NEVER: Never set accept-encoding/content-encoding header in outbound request/response
http: HeaderPosition
HeaderPosition
Defines the position of the headers in the request/response.
LEADING: Header is placed before the payload of the request/response
TRAILING: Header is placed after the payload of the request/response
http: OAuth2GrantConfig
OAuth2GrantConfig
Represents OAuth2 grant configurations for OAuth2 authentication.
http: ClientAuthConfig
ClientAuthConfig
Defines the authentication configurations for the HTTP client.
http: ListenerAuthConfig
ListenerAuthConfig
Defines the authentication configurations for the HTTP listener.
http: StatusCodeResponse
StatusCodeResponse
Defines the possible status code response record types.
http: Cloneable
Cloneable
Represents a non-error type that can be cloned.
http: ReqCtxMember
ReqCtxMember
Request context member type.
http: NextService
NextService
The return type of an interceptor service function
http: Interceptor
Interceptor
Types of HTTP interceptor services
http: SimpleQueryParamType
SimpleQueryParamType
Defines the possible simple query parameter types.
http: QueryParamType
QueryParamType
Defines the query parameter type supported with client resource methods.
Intersection types
http: InterceptorReturnError
InterceptorReturnError
Represents an error, which occurred due to a failure in interceptor return.
http: QueryParameterBindingError
QueryParameterBindingError
Represents an error, which occurred due to a query parameter binding.
http: PathParameterBindingError
PathParameterBindingError
Represents an error, which occurred due to a path parameter binding.
http: ListenerAuthnError
ListenerAuthnError
Defines the authentication error types that returned from listener.
http: ListenerAuthzError
ListenerAuthzError
Defines the authorization error types that returned from listener.
http: LoadBalanceActionError
LoadBalanceActionError
Represents an error occurred in an remote function of the Load Balance connector.
http: ServiceNotFoundError
ServiceNotFoundError
Represents Service Not Found error.
http: BadMatrixParamError
BadMatrixParamError
Represents Bad Matrix Parameter in the request error.
http: ResourceNotFoundError
ResourceNotFoundError
Represents an error, which occurred when the resource is not found during dispatching.
http: ResourcePathValidationError
ResourcePathValidationError
Represents an error, which occurred due to a path parameter constraint validation.
http: ResourceMethodNotAllowedError
ResourceMethodNotAllowedError
Represents an error, which occurred when the resource method is not allowed during dispatching.
http: UnsupportedRequestMediaTypeError
UnsupportedRequestMediaTypeError
Represents an error, which occurred when the media type is not supported during dispatching.
http: RequestNotAcceptableError
RequestNotAcceptableError
Represents an error, which occurred when the payload is not acceptable during dispatching.
http: ResourceDispatchingServerError
ResourceDispatchingServerError
Represents other internal server errors during dispatching.
http: StatusCodeResponseBindingError
StatusCodeResponseBindingError
Represents the client status code binding error
http: StatusCodeBindingClientRequestError
StatusCodeBindingClientRequestError
Represents the status code binding error that occurred due to 4XX status code response binding
http: StatusCodeBindingRemoteServerError
StatusCodeBindingRemoteServerError
Represents the status code binding error that occurred due to 5XX status code response binding
Type descriptor types
http: TargetType
TargetType
The types of data values that are expected by the HTTP client to return after the data binding operation.
http: ReqCtxMemberType
ReqCtxMemberType
Request context member type descriptor.