Package com.luciad.net.http

Interface IHttpClient

All Known Implementing Classes:

HttpClient

public interface IHttpClient

Interface for sending HTTP requests.

Implementations of this interface must be thread-safe.

See also the related guide on How to customize HTTP requests when loading data.

Since:

2023.0

Method Summary

Modifier and Type	Method	Description
HttpResponse	send(HttpRequest request, CancellationToken token)	Returns the HTTP response for the given HTTP request.

Method Details

send

@NotNull
HttpResponse send(@NotNull
 HttpRequest request,
 @NotNull
 CancellationToken token)
           throws IOException

Returns the HTTP response for the given HTTP request.

This method is synchronous and blocks until the request has been sent and the response has been received.

The request process can be canceled by the means of the cancellation token. It is up to the implementer to verify that the cancellation token state is set to true during the operation. When set to true this indicates that an HTTP response is no longer needed.

Parameters:

request - HTTP request.

token - Cancellation token.

Returns:

the HTTP response.

Throws:

IOException - when loading the data fails.