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
- config ClientConfiguration
Remote Methods
post | This wraps the |
head | This wraps the |
put | This wraps the |
execute | This wraps the |
patch | This wraps the |
delete | This wraps the |
get | This wraps the |
options | This wraps the |
forward | This wraps the |
submit | This wraps the |
getResponse | This just pass the request to actual network call. |
hasPromise | This just pass the request to actual network call. |
getNextPromise | This just pass the request to actual network call. |
getPromisedResponse | This just pass the request to actual network call. |
rejectPromise | This just pass the request to actual network call. |
Fields
- url string
-
The URL of the remote HTTP endpoint
- config ClientConfiguration {}
-
The configurations of the client endpoint associated with this
HttpActions
instance
- httpClient HttpClient
-
The underlying
HttpActions
instance, which will make the actual network calls
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
This wraps the 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
HttpFuture
that represents an asynchronous service invocation, or an error if the submission fails
This just pass the request to actual network call.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An HTTP response message, or an error if the invocation fails
This just pass the request to actual network call.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
that represents whether aPushPromise
exists
This just pass the request to actual network call.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An HTTP Push Promise message, or an error if the invocation fails
This just pass the request to actual network call.
Parameters
- promise PushPromise
-
The related
PushPromise
-
Return Type
(Response | ClientError) A promised HTTP
Response
message, or an error if the invocation fails
This just pass the request to actual network call.
Parameters
- promise PushPromise
-
The Push Promise to be rejected