com.github.mjeanroy.junit.servers.client

Interface HttpClient

All Known Implementing Classes:

AbstractHttpClient, ApacheHttpClient, AsyncHttpClient, NingAsyncHttpClient, OkHttpClient

public interface HttpClient

Http client that can be used to query embedded server.

After test suite, client should be properly destroyed using destroy() method.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy client.
HttpClientConfiguration	getConfiguration() Get the client configuration.
boolean	isDestroyed() Check that HTTP client has been destroyed.
HttpRequest	prepareDelete(String endpoint) Create DELETE request.
HttpRequest	prepareGet(String endpoint) Create GET request.
HttpRequest	prepareHead(String endpoint) Create HEAD request.
HttpRequest	preparePatch(String endpoint) Create PATCH request.
HttpRequest	preparePatch(String endpoint, HttpRequestBody body) Create PATCH request.
HttpRequest	preparePost(String endpoint) Create POST request.
HttpRequest	preparePost(String endpoint, HttpRequestBody body) Create POST request.
HttpRequest	preparePut(String url) Create PUT request.
HttpRequest	preparePut(String url, HttpRequestBody body) Create PUT request.
HttpRequest	prepareRequest(HttpMethod httpMethod, String endpoint) Create request.

Method Detail

getConfiguration

HttpClientConfiguration getConfiguration()

Get the client configuration.

Returns:

HTTP Client configuration.

prepareGet

HttpRequest prepareGet(String endpoint)

Create GET request.

Parameters:

endpoint - URL, full url or path relative to server url.

Returns:

GET request.

See Also:

prepareRequest(HttpMethod, String)

preparePost

HttpRequest preparePost(String endpoint)

Create POST request.

Parameters:

endpoint - URL, full url or path relative to server url.

Returns:

POST request.

See Also:

prepareRequest(HttpMethod, String)

preparePost

HttpRequest preparePost(String endpoint,
                        HttpRequestBody body)

Create POST request.

Parameters:

endpoint - URL, full url or path relative to server url.

body - Request body.

Returns:

POST request.

See Also:

prepareRequest(HttpMethod, String)

preparePut

HttpRequest preparePut(String url)

Create PUT request.

Parameters:

url - URL, full url or path relative to server url.

Returns:

PUT request.

See Also:

prepareRequest(HttpMethod, String)

preparePut

HttpRequest preparePut(String url,
                       HttpRequestBody body)

Create PUT request.

Parameters:

url - URL, full url or path relative to server url.

body - Request body.

Returns:

PUT request.

See Also:

prepareRequest(HttpMethod, String)

prepareDelete

HttpRequest prepareDelete(String endpoint)

Create DELETE request.

Parameters:

endpoint - URL, full url or path relative to server url.

Returns:

DELETE request.

See Also:

prepareRequest(HttpMethod, String)

preparePatch

HttpRequest preparePatch(String endpoint)

Create PATCH request.

Parameters:

endpoint - URL, full url or path relative to server url.

Returns:

PATCH request.

See Also:

prepareRequest(HttpMethod, String)

preparePatch

HttpRequest preparePatch(String endpoint,
                         HttpRequestBody body)

Create PATCH request.

Parameters:

endpoint - URL, full url or path relative to server url.

body - Request body.

Returns:

PATCH request.

See Also:

prepareRequest(HttpMethod, String)

prepareHead

HttpRequest prepareHead(String endpoint)

Create HEAD request.

Parameters:

endpoint - URL, full url or path relative to server url.

Returns:

HEAD request.

See Also:

prepareRequest(HttpMethod, String)

prepareRequest

HttpRequest prepareRequest(HttpMethod httpMethod,
                           String endpoint)

Create request.

Once destroyed, this client should not be able to create HTTP request and should throw an instance of IllegalStateException.

Parameters:

httpMethod - Http method (i.e GET, POST, PUT, DELETE).

endpoint - URL, full url or path relative to server url.

Returns:

The request.

Throws:

IllegalStateException - If client has already been destroyed.

See Also:

destroy(), isDestroyed()

destroy

void destroy()

Destroy client.

isDestroyed

boolean isDestroyed()

Check that HTTP client has been destroyed.

Returns:

true if client is closed, false otherwise.