ratpack.http.client

Interface HttpClient

public interface HttpClient

An asynchronous HttpClient.

Method Summary

Modifier and Type	Method and Description
default Promise<ReceivedResponse>	get(URI uri)
Promise<ReceivedResponse>	get(URI uri, Action<? super RequestSpec> action) An asynchronous method to do a GET HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a GET.
Promise<ReceivedResponse>	post(URI uri, Action<? super RequestSpec> action) An asynchronous method to do a POST HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a POST.
Promise<ReceivedResponse>	request(URI uri, Action<? super RequestSpec> action) An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec.
Promise<StreamedResponse>	requestStream(URI uri, Action<? super RequestSpec> requestConfigurer) An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, the received response content will be streamed.

Method Detail

get

Promise<ReceivedResponse> get(URI uri,
                              Action<? super RequestSpec> action)

An asynchronous method to do a GET HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a GET.

Parameters:

uri - the request URL (as a URI), must be of the http or https protocol

action - An action that will act on the RequestSpec

Returns:

A promise for a ReceivedResponse

get

default Promise<ReceivedResponse> get(URI uri)

post

Promise<ReceivedResponse> post(URI uri,
                               Action<? super RequestSpec> action)

An asynchronous method to do a POST HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a POST.

Parameters:

uri - the request URL (as a URI), must be of the http or https protocol

action - An action that will act on the RequestSpec

Returns:

A promise for a ReceivedResponse

request

Promise<ReceivedResponse> request(URI uri,
                                  Action<? super RequestSpec> action)

An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec.

Parameters:

uri - the request URL (as a URI), must be of the http or https protocol

action - An action that will act on the RequestSpec

Returns:

A promise for a ReceivedResponse

requestStream

Promise<StreamedResponse> requestStream(URI uri,
                                        Action<? super RequestSpec> requestConfigurer)

An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, the received response content will be streamed.

In order to access the response content stream either subscribe to the Publisher returned from StreamedResponse.getBody() or use StreamedResponse.send(ratpack.http.Response, ratpack.func.Action) to directly stream the content as a server response.

Parameters:

uri - the request URL (as a URI), must be of the http or https protocol

requestConfigurer - an action that will act on the RequestSpec

Returns:

a promise for a StreamedResponse

See Also:

StreamedResponse