net.officefloor.plugin.socket.server.http

Class HttpTestUtil

java.lang.Object

net.officefloor.plugin.socket.server.http.HttpTestUtil

public class HttpTestUtil
extends Object

Utility class aiding in testing HTTP functionality.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
static org.apache.http.client.CredentialsProvider	configureCredentials(org.apache.http.impl.client.HttpClientBuilder builder, String realm, String scheme, String username, String password) Configures CredentialsProvider for the HttpClientBuilder.
static void	configureHttps(org.apache.http.impl.client.HttpClientBuilder builder) Configures the HttpClientBuilder for HTTPS.
static void	configureNoRedirects(org.apache.http.impl.client.HttpClientBuilder builder) Configures no redirects for the HttpClientBuilder.
static org.apache.http.impl.client.CloseableHttpClient	createHttpClient() Creates a CloseableHttpClient ready for use with default values.
static org.apache.http.impl.client.CloseableHttpClient	createHttpClient(boolean isSecure) Creates a CloseableHttpClient ready for use.
static HttpRequest	createHttpRequest(String method, String requestUri, String entity, String... headerNameValues) Creates a HttpRequest for testing.
static int	getAvailablePort() Obtains the next port number for testing.
static String	getEntityBody(org.apache.http.HttpResponse response) Obtains the HttpEntity content.
static String	getEntityBody(org.apache.http.HttpResponse response, Charset charset) Obtains the HttpEntity content.
static Class<? extends SslEngineSource>	getSslEngineSourceClass() Obtains the SslEngineSource for the corresponding configured HTTPS.

Methods inherited from class java.lang.Object

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

Method Detail

getAvailablePort

public static int getAvailablePort()

Obtains the next port number for testing.

Returns:

Next port number for testing.

getEntityBody

public static String getEntityBody(org.apache.http.HttpResponse response)
                            throws IOException

Obtains the HttpEntity content.

Parameters:

response - HttpResponse.

Returns:

Content of HttpEntity.

Throws:

IOException - If fails to obtain content.

getEntityBody

public static String getEntityBody(org.apache.http.HttpResponse response,
                                   Charset charset)
                            throws IOException

Obtains the HttpEntity content.

Parameters:

response - HttpResponse.

charset - Charset.

Returns:

Content of HttpEntity.

Throws:

IOException - If fails to obtain content.

createHttpClient

public static org.apache.http.impl.client.CloseableHttpClient createHttpClient()

Creates a CloseableHttpClient ready for use with default values.

Returns:

CloseableHttpClient.

createHttpClient

public static org.apache.http.impl.client.CloseableHttpClient createHttpClient(boolean isSecure)

Creates a CloseableHttpClient ready for use.

Parameters:

isSecure - Indicate if require secure connection.

Returns:

CloseableHttpClient.

configureHttps

public static void configureHttps(org.apache.http.impl.client.HttpClientBuilder builder)

Configures the HttpClientBuilder for HTTPS.

Parameters:

builder - HttpClientBuilder.

See Also:

getSslEngineSourceClass()

configureNoRedirects

public static void configureNoRedirects(org.apache.http.impl.client.HttpClientBuilder builder)

Configures no redirects for the HttpClientBuilder.

Parameters:

builder - HttpClientBuilder.

configureCredentials

public static org.apache.http.client.CredentialsProvider configureCredentials(org.apache.http.impl.client.HttpClientBuilder builder,
                                                                              String realm,
                                                                              String scheme,
                                                                              String username,
                                                                              String password)

Configures CredentialsProvider for the HttpClientBuilder.

Parameters:

builder - HttpClientBuilder.

realm - Security realm.

scheme - Security scheme.

username - User name.

password - Password.

Returns:

CredentialsProvider.

getSslEngineSourceClass

public static Class<? extends SslEngineSource> getSslEngineSourceClass()

Obtains the SslEngineSource for the corresponding configured HTTPS.

Returns:

SslEngineSource for the corresponding configured HTTPS.

See Also:

configureHttps(HttpClientBuilder)

createHttpRequest

public static HttpRequest createHttpRequest(String method,
                                            String requestUri,
                                            String entity,
                                            String... headerNameValues)
                                     throws Exception

Creates a HttpRequest for testing.

Parameters:

method - HTTP method (GET, POST).

requestUri - Request URI.

entity - Contents of the HttpRequest entity.

headerNameValues - HttpHeader name values.

Returns:

HttpRequest.

Throws:

Exception - If fails to create the HttpRequest .