com.github.paweladamski.httpclientmock

Class HttpClientMock

java.lang.Object

org.apache.http.impl.client.CloseableHttpClient

com.github.paweladamski.httpclientmock.HttpClientMock

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.client.HttpClient

public class HttpClientMock
extends org.apache.http.impl.client.CloseableHttpClient

Constructor Summary

Constructors

Constructor and Description
HttpClientMock() Creates mock of Apache HttpClient
HttpClientMock(String defaultHost) Creates mock of Apache HttpClient with default host.

Method Summary

Modifier and Type	Method and Description
void	close()
void	debugOff()
void	debugOn()
protected org.apache.http.client.methods.CloseableHttpResponse	doExecute(org.apache.http.HttpHost httpHost, org.apache.http.HttpRequest httpRequest, org.apache.http.protocol.HttpContext httpContext)
org.apache.http.conn.ClientConnectionManager	getConnectionManager()
org.apache.http.params.HttpParams	getParams()
HttpClientMockBuilder	onDelete() Starts defining new rule which requires HTTP DELETE method.
HttpClientMockBuilder	onDelete(String url) Starts defining new rule which requires HTTP DELETE method and url.
HttpClientMockBuilder	onGet() Starts defining new rule which requires HTTP GET method.
HttpClientMockBuilder	onGet(String url) Starts defining new rule which requires HTTP GET method and url.
HttpClientMockBuilder	onHead() Starts defining new rule which requires HTTP HEAD method.
HttpClientMockBuilder	onHead(String url) Starts defining new rule which requires HTTP HEAD method and url.
HttpClientMockBuilder	onOption() Starts defining new rule which requires HTTP OPTION method.
HttpClientMockBuilder	onOptions(String url) Starts defining new rule which requires HTTP OPTIONS method and url.
HttpClientMockBuilder	onPatch() Starts defining new rule which requires HTTP PATCH method.
HttpClientMockBuilder	onPatch(String url) Starts defining new rule which requires HTTP PATCH method and url.
HttpClientMockBuilder	onPost() Starts defining new rule which requires HTTP POST method.
HttpClientMockBuilder	onPost(String url) Starts defining new rule which requires HTTP POST method and url.
HttpClientMockBuilder	onPut() Starts defining new rule which requires HTTP PUT method.
HttpClientMockBuilder	onPut(String url) Starts defining new rule which requires HTTP PUT method and url.
void	reset() Resets mock to initial state where there are no rules and no previous requests.
HttpClientVerify	verify() Creates verification builder.

Methods inherited from class org.apache.http.impl.client.CloseableHttpClient

execute, execute, execute, execute, execute, execute, execute, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientMock

public HttpClientMock()

Creates mock of Apache HttpClient

HttpClientMock

public HttpClientMock(String defaultHost)

Creates mock of Apache HttpClient with default host. All defined conditions without host will use default host

Parameters:

defaultHost - default host for later conditions

Method Detail

reset

public void reset()

Resets mock to initial state where there are no rules and no previous requests.

verify

public HttpClientVerify verify()

Creates verification builder.

Returns:

request number verification builder

onPost

public HttpClientMockBuilder onPost()

Starts defining new rule which requires HTTP POST method.

Returns:

HttpClientMockBuilder which allows to define new rule

onGet

public HttpClientMockBuilder onGet()

Starts defining new rule which requires HTTP GET method.

Returns:

HttpClientMockBuilder which allows to define new rule

onDelete

public HttpClientMockBuilder onDelete()

Starts defining new rule which requires HTTP DELETE method.

Returns:

HttpClientMockBuilder which allows to define new rule

onHead

public HttpClientMockBuilder onHead()

Starts defining new rule which requires HTTP HEAD method.

Returns:

HttpClientMockBuilder which allows to define new rule

onOption

public HttpClientMockBuilder onOption()

Starts defining new rule which requires HTTP OPTION method.

Returns:

HttpClientMockBuilder which allows to define new rule

onPut

public HttpClientMockBuilder onPut()

Starts defining new rule which requires HTTP PUT method.

Returns:

HttpClientMockBuilder which allows to define new rule

onPatch

public HttpClientMockBuilder onPatch()

Starts defining new rule which requires HTTP PATCH method.

Returns:

HttpClientMockBuilder which allows to define new rule

onGet

public HttpClientMockBuilder onGet(String url)

Starts defining new rule which requires HTTP GET method and url. If provided url starts with "/" request url must be equal to concatenation of default host and url. Otherwise request url must equal to provided url. If provided url contains query parameters and/or reference they are parsed and added as a separate conditions.

For example:
httpClientMock.onGet("http://localhost/login?user=Ben#edit");
is equal to
httpClientMock.onGet("http://localhost/login").withParameter("user","Ben").withReference("edit);

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onPost

public HttpClientMockBuilder onPost(String url)

Starts defining new rule which requires HTTP POST method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onPut

public HttpClientMockBuilder onPut(String url)

Starts defining new rule which requires HTTP PUT method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onDelete

public HttpClientMockBuilder onDelete(String url)

Starts defining new rule which requires HTTP DELETE method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onHead

public HttpClientMockBuilder onHead(String url)

Starts defining new rule which requires HTTP HEAD method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onOptions

public HttpClientMockBuilder onOptions(String url)

Starts defining new rule which requires HTTP OPTIONS method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

onPatch

public HttpClientMockBuilder onPatch(String url)

Starts defining new rule which requires HTTP PATCH method and url. URL works the same way as in onGet

Parameters:

url - required url

Returns:

HttpClientMockBuilder which allows to define new rule

doExecute

protected org.apache.http.client.methods.CloseableHttpResponse doExecute(org.apache.http.HttpHost httpHost,
                                                                         org.apache.http.HttpRequest httpRequest,
                                                                         org.apache.http.protocol.HttpContext httpContext)
                                                                  throws IOException

Specified by:

doExecute in class org.apache.http.impl.client.CloseableHttpClient

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

getParams

public org.apache.http.params.HttpParams getParams()

getConnectionManager

public org.apache.http.conn.ClientConnectionManager getConnectionManager()

debugOn

public void debugOn()

debugOff

public void debugOff()