Clients -
http :
HttpSecureClient
Provides secure HTTP remote functions for interacting with HTTP endpoints. This will make use of the authentication schemes configured in the HTTP client endpoint to secure the HTTP requests.
Constructor
__init
(string url, ClientConfiguration config)
- url string
-
URL of the target service
- config ClientConfiguration
-
The configurations to be used when initializing the
client
Remote Methods
post | This wraps the HttpSecureClient.post() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
head | This wraps the HttpSecureClient.head() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
put | This wraps the HttpSecureClient.put() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
execute | This wraps the HttpSecureClient.execute() function of the underlying HTTP remote functions provider. Add relevant authentication
headers o the request and send the request to actual network call.
|
patch | This wraps the HttpSecureClient.patch() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
delete | This wraps the HttpSecureClient.delete() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
get | This wraps the HttpSecureClient.get() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
options | This wraps the HttpSecureClient.options() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
forward | This wraps the HttpSecureClient.forward() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
submit | This wraps the HttpSecureClient.submit() function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
|
getResponse | This just passes the request to the actual network call. |
hasPromise | Passes the request to an actual network call. |
getNextPromise | Passes the request to an actual network call. |
getPromisedResponse | Passes the request to an actual network call. |
rejectPromise | Passes the request to an actual network call. |
Fields
- url string
-
The URL of the remote HTTP endpoint
- config ClientConfiguration (default {})
-
The configurations of the client endpoint associated with this
HttpActions
instance
- httpClient HttpClient
-
The underlying
HttpActions
instance, which will make the actual network calls
HttpSecureClient.post()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.head()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.put()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or an error occurred while attempting to fulfill the HTTP request
HttpSecureClient.execute()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers o the request and send the request to actual network call.
Parameters
- httpVerb string
-
HTTP verb value
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or an error occurred while attempting to fulfill the HTTP request
HttpSecureClient.patch()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or an error occurred while attempting to fulfill the HTTP request
HttpSecureClient.delete()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.get()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Request path
- message RequestMessage (default ())
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.options()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- path string
-
Request path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.forward()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
-
Return Type
(Response | ClientError) The inbound response message or the error if one occurred while attempting to fulfill the HTTP request
HttpSecureClient.submit()
function of the underlying HTTP remote functions provider. Add relevant authentication
headers to the request and send the request to actual network call.
Parameters
- httpVerb string
-
The HTTP verb value
- path string
-
The resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
, ormime:Entity[]
-
Return Type
(HttpFuture | ClientError) An
http:HttpFuture
that represents an asynchronous service invocation, or else anhttp:ClientError
if the submission fails
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An
http:Response
message or else anhttp:ClientError
if the invocation fails
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
, which represents whether anhttp:PushPromise
exists
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An
http:PushPromise
message or else anhttp:ClientError
if the invocation fails
Parameters
- promise PushPromise
-
The related
http:PushPromise
-
Return Type
(Response | ClientError) A promised
http:Response
message or else anhttp:ClientError
if the invocation fails
Parameters
- promise PushPromise
-
The Push Promise to be rejected