com.github.mjeanroy.junit.servers.client

Enum HttpClientStrategy

java.lang.Object

java.lang.Enum<HttpClientStrategy>

com.github.mjeanroy.junit.servers.client.HttpClientStrategy

All Implemented Interfaces:

Serializable, Comparable<HttpClientStrategy>

public enum HttpClientStrategy
extends Enum<HttpClientStrategy>

Available strategies that can be used to build appropriate implementation of http client.

Currently, following strategies are available:

• ASYNC_HTTP_CLIENT: use the async-http-client library.
• OK_HTTP3: use OkHttp library.
• NING_ASYNC_HTTP_CLIENT: use async-http-client from ning library.
• APACHE_HTTP_CLIENT: use apache http-client library.
• AUTO: use classpath detection and choose the best available strategy (see below).

How the "best" strategy is selected:
Classpath detection is implemented in this order:

1. If OkHttp library is detected, this strategy is automatically selected.
2. If async-http-client is detected, this strategy is automatically (note that this strategy will be skipped with a jdk < 8, since this library requires Java 8).
3. Third test is ning-async-http-client, and it will be selected if library is detected.
4. Finally, apache httpcomponent will be selected if available.
5. If none of these libraries are available, an exception will be thrown.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APACHE_HTTP_CLIENT Build http client using ApacheHttpClient library.
ASYNC_HTTP_CLIENT Build http client using AsyncHttpClient library.
AUTO Detect class available on classpath and use appropriate strategy to build http client client implementation: Try OK_HTTP3. Try ASYNC_HTTP_CLIENT. Try NING_ASYNC_HTTP_CLIENT. Try APACHE_HTTP_CLIENT.
NING_ASYNC_HTTP_CLIENT Build http client using (Ning) AsyncHttpClient library.
OK_HTTP3 Build http client using OkHttp library.

Method Summary

Modifier and Type	Method and Description
HttpClient	build(EmbeddedServer<? extends AbstractConfiguration> server) Return the http client implementation.
HttpClient	build(HttpClientConfiguration configuration, EmbeddedServer<? extends AbstractConfiguration> server) Return the http client implementation.
abstract boolean	support() Check if the strategy can be used as it is supported by the runtime environment.
static HttpClientStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpClientStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK_HTTP3

public static final HttpClientStrategy OK_HTTP3

Build http client using OkHttp library.

ASYNC_HTTP_CLIENT

public static final HttpClientStrategy ASYNC_HTTP_CLIENT

Build http client using AsyncHttpClient library.

This strategy requires Java 8.

NING_ASYNC_HTTP_CLIENT

public static final HttpClientStrategy NING_ASYNC_HTTP_CLIENT

Build http client using (Ning) AsyncHttpClient library.

APACHE_HTTP_CLIENT

public static final HttpClientStrategy APACHE_HTTP_CLIENT

Build http client using ApacheHttpClient library.

AUTO

public static final HttpClientStrategy AUTO

Detect class available on classpath and use appropriate strategy to build http client client implementation:

1. Try OK_HTTP3.
2. Try ASYNC_HTTP_CLIENT.
3. Try NING_ASYNC_HTTP_CLIENT.
4. Try APACHE_HTTP_CLIENT.

Method Detail

values

public static HttpClientStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpClientStrategy c : HttpClientStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpClientStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

build

public HttpClient build(EmbeddedServer<? extends AbstractConfiguration> server)

Return the http client implementation.

Parameters:

server - Embedded server.

Returns:

Http client.

Throws:

UnsupportedOperationException - If the runtime environment does not allow the strategy (such as: the library has not been imported).

build

public HttpClient build(HttpClientConfiguration configuration,
                        EmbeddedServer<? extends AbstractConfiguration> server)

Return the http client implementation.

Parameters:

configuration - HTTP Client configuration.

server - Embedded server.

Returns:

Http client.

Throws:

UnsupportedOperationException - If the runtime environment does not allow the strategy (such as: the library has not been imported).

support

public abstract boolean support()

Check if the strategy can be used as it is supported by the runtime environment.

Returns:

true if the strategy can be instantiated, false otherwise.