com.github.mjeanroy.junit.servers.client.impl.okhttp3

Class OkHttpClient

java.lang.Object

com.github.mjeanroy.junit.servers.client.impl.AbstractHttpClient

com.github.mjeanroy.junit.servers.client.impl.okhttp3.OkHttpClient

All Implemented Interfaces:

HttpClient

public class OkHttpClient
extends AbstractHttpClient
implements HttpClient

Implementation of HttpClient using OkHttp library from Square.

See Also:

HttpClientStrategy.OK_HTTP3, http://square.github.io/okhttp

Method Summary

Modifier and Type	Method and Description
protected HttpRequest	buildRequest(HttpMethod httpMethod, HttpUrl endpoint) Build request object.
static OkHttpClient	defaultOkHttpClient(EmbeddedServer<?> server) Create new http client using internal http client from ok-http library.
void	destroy() Destroy client.
boolean	isDestroyed() Check that HTTP client has been destroyed.
static OkHttpClient	newOkHttpClient(EmbeddedServer<?> server, okhttp3.OkHttpClient client) Deprecated. Use newOkHttpClient(HttpClientConfiguration, EmbeddedServer)
static OkHttpClient	newOkHttpClient(HttpClientConfiguration configuration, EmbeddedServer<?> server) Create new http client using custom configuration.

Methods inherited from class com.github.mjeanroy.junit.servers.client.impl.AbstractHttpClient

finalize, getConfiguration, prepareDelete, prepareGet, prepareHead, preparePatch, preparePost, preparePut, prepareRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.mjeanroy.junit.servers.client.HttpClient

getConfiguration, prepareDelete, prepareGet, prepareHead, preparePatch, preparePost, preparePut, prepareRequest

Method Detail

defaultOkHttpClient

public static OkHttpClient defaultOkHttpClient(EmbeddedServer<?> server)

Create new http client using internal http client from ok-http library.

Parameters:

server - Embedded server.

Returns:

Http client.

Throws:

NullPointerException - If server is null.

newOkHttpClient

public static OkHttpClient newOkHttpClient(HttpClientConfiguration configuration,
                                           EmbeddedServer<?> server)

Create new http client using custom configuration.

Parameters:

configuration - Client configuration.

server - Embedded server.

Returns:

Http client.

Throws:

NullPointerException - If server or configuration are null.

newOkHttpClient

@Deprecated
public static OkHttpClient newOkHttpClient(EmbeddedServer<?> server,
                                                       okhttp3.OkHttpClient client)

Deprecated. Use newOkHttpClient(HttpClientConfiguration, EmbeddedServer)

Create new http client using custom internal http client from ok-http library.

Parameters:

server - Embedded server.

client - The custom client.

Returns:

Http client.

Throws:

NullPointerException - If server or client are null.

buildRequest

protected HttpRequest buildRequest(HttpMethod httpMethod,
                                   HttpUrl endpoint)

Description copied from class: AbstractHttpClient

Build request object.

Specified by:

buildRequest in class AbstractHttpClient

Parameters:

httpMethod - Http method.

endpoint - Request url.

Returns:

Http request.

destroy

public void destroy()

Description copied from interface: HttpClient

Destroy client.

Specified by:

destroy in interface HttpClient

isDestroyed

public boolean isDestroyed()

Description copied from interface: HttpClient

Check that HTTP client has been destroyed.

Specified by:

isDestroyed in interface HttpClient

Returns:

true if client is closed, false otherwise.