io.apimatic.okhttpclient.adapter

Class OkClient

java.lang.Object

io.apimatic.okhttpclient.adapter.OkClient

All Implemented Interfaces:

io.apimatic.coreinterfaces.http.HttpClient

public class OkClient
extends Object
implements io.apimatic.coreinterfaces.http.HttpClient

HTTP Client class to send HTTP Requests and read the responses.

Constructor Summary

Constructors

Constructor and Description
OkClient(io.apimatic.coreinterfaces.http.ClientConfiguration httpClientConfig, io.apimatic.coreinterfaces.compatibility.CompatibilityFactory compatibilityFactory) Constructor to initialize the OKClient.

Method Summary

Modifier and Type	Method and Description
static okhttp3.Authenticator	buildProxyAuthenticator(String username, String password) Builds a proxy authenticator using the provided credentials.
static io.apimatic.coreinterfaces.http.response.Response	convertResponse(io.apimatic.coreinterfaces.http.request.Request request, okhttp3.Response response, boolean hasBinaryResponse) Converts a given OkHttp response into our internal http response model.
io.apimatic.coreinterfaces.http.response.Response	execute(io.apimatic.coreinterfaces.http.request.Request httpRequest, io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration endpointConfiguration) Execute a given Request to get string/binary response back.
CompletableFuture<io.apimatic.coreinterfaces.http.response.Response>	executeAsync(io.apimatic.coreinterfaces.http.request.Request httpRequest, io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration endpointConfiguration) Execute a given Request to get string/binary response back.
static void	shutdown() Shutdown the underlying OkHttpClient instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OkClient

public OkClient(io.apimatic.coreinterfaces.http.ClientConfiguration httpClientConfig,
                io.apimatic.coreinterfaces.compatibility.CompatibilityFactory compatibilityFactory)

Constructor to initialize the OKClient.

Parameters:

httpClientConfig - The httpClientConfiguration

compatibilityFactory - The compatibilityFactory for backward compatibility

Method Detail

buildProxyAuthenticator

public static okhttp3.Authenticator buildProxyAuthenticator(String username,
                                                            String password)

Builds a proxy authenticator using the provided credentials.

Parameters:

username - the proxy username

password - the proxy password

Returns:

an Authenticator that adds Proxy-Authorization headers, or null if credentials are incomplete

shutdown

public static void shutdown()

Shutdown the underlying OkHttpClient instance.

executeAsync

public CompletableFuture<io.apimatic.coreinterfaces.http.response.Response> executeAsync(io.apimatic.coreinterfaces.http.request.Request httpRequest,
                                                                                         io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration endpointConfiguration)

Execute a given Request to get string/binary response back.

Specified by:

executeAsync in interface io.apimatic.coreinterfaces.http.HttpClient

Parameters:

httpRequest - The given Request to execute.

endpointConfiguration - The endpoint configuration for request.

Returns:

CompletableFuture of HttpResponse after execution.

execute

public io.apimatic.coreinterfaces.http.response.Response execute(io.apimatic.coreinterfaces.http.request.Request httpRequest,
                                                                 io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration endpointConfiguration)
                                                          throws IOException

Execute a given Request to get string/binary response back.

Specified by:

execute in interface io.apimatic.coreinterfaces.http.HttpClient

Parameters:

httpRequest - The given Request to execute.

endpointConfiguration - The endpointConfiguration for request.

Returns:

The converted http response.

Throws:

IOException - Exception to be thrown while converting response.

convertResponse

public static io.apimatic.coreinterfaces.http.response.Response convertResponse(io.apimatic.coreinterfaces.http.request.Request request,
                                                                                okhttp3.Response response,
                                                                                boolean hasBinaryResponse)
                                                                         throws IOException

Converts a given OkHttp response into our internal http response model.

Parameters:

request - The given http request in internal format.

response - The given OkHttp response.

hasBinaryResponse - Whether the response is binary or string.

Returns:

The converted http response.

Throws:

IOException - exception to be thrown while converting response.