io.induct.http

Interface HttpClient

public interface HttpClient

Low level HTTP client abstraction for interacting with HTTP APIs or alternatively functional test derivatives. The signature of this interface is to promote simplicity with testing in mind, whether it's hot swapping clients, mocking in tests or wrapping a framework specific testing library. All implementations are to be used by utilising try-with-resources blocks:

try (Response response = httpClient.{method}(url, params, headers, body) {
  // work with the values from response
}

The Response interface is designed to allow implementations to halt processing of the incoming response at any time. TRACE and CONNECT are omitted as they are not generally used for normal HTTP interaction.

Since:

15.2.2015

Method Summary

Modifier and Type	Method and Description
Response	delete(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP DELETE call.
Response	get(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP GET call.
Response	head(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP HEAD call.
Response	options(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP OPTIONS call.
Response	post(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP POST call.
Response	put(java.lang.String url, com.google.common.collect.Multimap<java.lang.String,java.lang.String> params, com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers, java.io.InputStream requestBody) Perform HTTP PUT call.

Method Detail

options

Response options(java.lang.String url,
                 com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
                 com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
                 java.io.InputStream requestBody)

Perform HTTP OPTIONS call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send. Note that HTTP OPTIONS does not specify any use for this in HTTP1.1 spec

Returns:

Server response

See Also:

RFC-2616 9.2 OPTIONS

get

Response get(java.lang.String url,
             com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
             com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
             java.io.InputStream requestBody)

Perform HTTP GET call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send

Returns:

Server response

See Also:

RFC-2616 9.3 GET

head

Response head(java.lang.String url,
              com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
              com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
              java.io.InputStream requestBody)

Perform HTTP HEAD call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send

Returns:

Server response

See Also:

RFC-2616 9.4 HEAD

post

Response post(java.lang.String url,
              com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
              com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
              java.io.InputStream requestBody)

Perform HTTP POST call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send

Returns:

Server response

See Also:

RFC-2616 9.5 POST

put

Response put(java.lang.String url,
             com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
             com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
             java.io.InputStream requestBody)

Perform HTTP PUT call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send

Returns:

Server response

See Also:

RFC-2616 9.6 PUT

delete

Response delete(java.lang.String url,
                com.google.common.collect.Multimap<java.lang.String,java.lang.String> params,
                com.google.common.collect.Multimap<java.lang.String,java.lang.String> headers,
                java.io.InputStream requestBody)

Perform HTTP DELETE call.

Parameters:

url - Full URL including scheme, authority and path

params - URL parameters for the call

headers - HTTP headers to send with the call

requestBody - Request body to send

Returns:

Server response

See Also:

RFC-2616 9.7 DELETE