io.servicetalk.http.api

Interface BlockingHttpClient

All Superinterfaces:

AutoCloseable, BlockingHttpRequester, GracefulAutoCloseable, HttpRequestFactory

public interface BlockingHttpClient
extends BlockingHttpRequester

The equivalent of HttpClient but with synchronous/blocking APIs instead of asynchronous APIs.

Method Summary

Modifier and Type	Method and Description
default BlockingStreamingHttpClient	asBlockingStreamingClient() Convert this BlockingHttpClient to the BlockingStreamingHttpClient API.
default HttpClient	asClient() Convert this BlockingHttpClient to the HttpClient API.
StreamingHttpClient	asStreamingClient() Convert this BlockingHttpClient to the StreamingHttpClient API.
HttpResponse	request(HttpRequest request) Send a request.
default ReservedBlockingHttpConnection	reserveConnection(HttpExecutionStrategy strategy, HttpRequestMetaData metaData) Deprecated. Use reserveConnection(HttpRequestMetaData). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.
ReservedBlockingHttpConnection	reserveConnection(HttpRequestMetaData metaData) Reserve a BlockingHttpConnection based on provided HttpRequestMetaData.

Methods inherited from interface BlockingHttpRequester

close, executionContext, httpResponseFactory, request

Methods inherited from interface HttpRequestFactory

connect, delete, get, head, newRequest, options, patch, post, put, trace

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Method Detail

request

HttpResponse request(HttpRequest request)
              throws Exception

Send a request.

Specified by:

request in interface BlockingHttpRequester

Parameters:

request - the request to send.

Returns:

The response.

Throws:

Exception - if an exception occurs during the request processing.

reserveConnection

ReservedBlockingHttpConnection reserveConnection(HttpRequestMetaData metaData)
                                          throws Exception

Reserve a BlockingHttpConnection based on provided HttpRequestMetaData.

Parameters:

metaData - Allows the underlying layers to know what BlockingHttpConnections are valid to reserve for future requests with the same HttpRequestMetaData. For example this may provide some insight into shard or other info.

Returns:

a ReservedBlockingHttpConnection.

Throws:

Exception - if a exception occurs during the reservation process.

reserveConnection

@Deprecated
default ReservedBlockingHttpConnection reserveConnection(HttpExecutionStrategy strategy,
                                                                     HttpRequestMetaData metaData)
                                                              throws Exception

Deprecated. Use reserveConnection(HttpRequestMetaData). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.

Reserve a BlockingHttpConnection based on provided HttpRequestMetaData.

Parameters:

strategy - HttpExecutionStrategy to use.

metaData - Allows the underlying layers to know what BlockingHttpConnections are valid to reserve for future requests with the same HttpRequestMetaData. For example this may provide some insight into shard or other info.

Returns:

a ReservedBlockingHttpConnection.

Throws:

Exception - if an exception occurs during the reservation process.

asStreamingClient

StreamingHttpClient asStreamingClient()

Convert this BlockingHttpClient to the StreamingHttpClient API.

Returns:

a StreamingHttpClient representation of this BlockingHttpClient.

asClient

default HttpClient asClient()

Convert this BlockingHttpClient to the HttpClient API.

Returns:

a HttpClient representation of this BlockingHttpClient.

asBlockingStreamingClient

default BlockingStreamingHttpClient asBlockingStreamingClient()

Convert this BlockingHttpClient to the BlockingStreamingHttpClient API.

Returns:

a BlockingStreamingHttpClient representation of this BlockingHttpClient.