Clients -
http :
RedirectClient
Provides redirect functionality for HTTP client remote functions.
Constructor
__init
(string url, ClientConfiguration config, FollowRedirects redirectConfig, HttpClient httpClient)
- url string
-
Target service url
- config ClientConfiguration
-
HTTP ClientConfiguration to be used for HTTP client invocation
- redirectConfig FollowRedirects
-
Configurations associated with redirect
- httpClient HttpClient
-
HTTP client for outbound HTTP requests
Remote Methods
forward | The |
execute | The |
submit | Submits an HTTP request to a service with the specified HTTP verb.
The |
Methods
If the received response for the RedirectClient.get()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.get()
function.
If the received response for the RedirectClient.post()
remote function is redirect eligible, redirect will
be performed automaticallyby this RedirectClient.post()
function.
If the received response for the RedirectClient.head()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.head()
function.
If the received response for the RedirectClient.put()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.put()
function.
If the received response for the RedirectClient.patch()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.patch()
function.
If the received response for the RedirectClient.delete()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.delete()
function.
If the received response for the RedirectClient.options()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.options()
function.
Retrieves the Response
for a previously submitted request.
Checks whether a PushPromise
exists for a previously submitted request.
Retrieves the next available PushPromise
for a previously submitted request.
Retrieves the promised server push Response
message.
Rejects a PushPromise
.
When a PushPromise
is rejected, there is no chance of fetching a promised response using the rejected promise.
Fields
- url string
-
Target service url
- config ClientConfiguration
-
HTTP ClientConfiguration to be used for HTTP client invocation
- redirectConfig FollowRedirects
-
Configurations associated with redirect
- httpClient HttpClient
-
HTTP client for outbound HTTP requests
- currentRedirectCount int 0
-
Current redirect count of the HTTP client
The RedirectClient.forward()
function is used to invoke an HTTP call with inbound request's HTTP verb.
-
Return Type
(Response | ClientError) The HTTP
Response
message, or an error if the invocation fails
The RedirectClient.execute()
sends an HTTP request to a service with the specified HTTP verb. Redirect will be
performed only for HTTP methods.
Parameters
- httpVerb string
-
The 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 HTTP
Response
message, or an error if the invocation fails
Submits an HTTP request to a service with the specified HTTP verb.
The RedirectClient.submit()
function does not give out a Response
as the result,
rather it returns an HttpFuture
which can be used to do further interactions with the endpoint.
Parameters
- httpVerb string
-
The HTTP verb value
- path string
-
The resource path
- message RequestMessage
-
An HTTP outbound request 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
If the received response for the RedirectClient.get()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.get()
function.
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 HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.post()
remote function is redirect eligible, redirect will
be performed automaticallyby this RedirectClient.post()
function.
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 HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.head()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.head()
function.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.put()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.put()
function.
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 HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.patch()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.patch()
function.
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 HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.delete()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.delete()
function.
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 HTTP
Response
message, or an error if the invocation fails
If the received response for the RedirectClient.options()
remote function is redirect eligible, redirect will be
performed automatically by this RedirectClient.options()
function.
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 HTTP
Response
message, or an error if the invocation fails
Retrieves the Response
for a previously submitted request.
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
Checks whether a PushPromise
exists for a previously submitted request.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
that represents whether aPushPromise
exists
Retrieves the next available PushPromise
for a previously submitted request.
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
Retrieves the promised server push Response
message.
Parameters
- promise PushPromise
-
The related
PushPromise
-
Return Type
(Response | ClientError) A promised HTTP
Response
message, or an error if the invocation fails
Rejects a PushPromise
.
When a 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