com.github.paweladamski.httpclientmock

Class HttpClientVerifyBuilder

java.lang.Object

com.github.paweladamski.httpclientmock.HttpClientVerifyBuilder

public class HttpClientVerifyBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
void	called() Verifies if there was exactly one request matching defined conditions.
void	called(int numberOfCalls) Verifies number of request matching defined conditions.
void	called(org.hamcrest.Matcher<Integer> numberOfCalls) Verifies number of request matching defined conditions.
void	notCalled() Verifies if there were no request matching defined conditions.
HttpClientVerifyBuilder	with(Condition condition) Adds custom conditions.
HttpClientVerifyBuilder	withBody(org.hamcrest.Matcher<String> matcher) Adds body condition.
HttpClientVerifyBuilder	withExtraFormParameters() Allows extra parameters (not defined in condition) in form.
HttpClientVerifyBuilder	withExtraParameters() Allows extra parameters (not defined in condition) in query.
HttpClientVerifyBuilder	withFormParameter(String name, org.hamcrest.Matcher<String> matcher) Request body must contain the given URL-encoded form parameter (typically found in POST requests).
HttpClientVerifyBuilder	withFormParameter(String name, String value) Request body must contain the given URL-encoded form parameter (typically found in POST requests).
HttpClientVerifyBuilder	withFormParameters(ParametersMatcher parameters) Request body must contain the given URL-encoded form parameters (typically used in POST requests).
HttpClientVerifyBuilder	withHeader(String header, org.hamcrest.Matcher<String> matcher) Adds header condition.
HttpClientVerifyBuilder	withHeader(String header, String value) Adds header condition.
HttpClientVerifyBuilder	withHost(String host) Adds host condition.
HttpClientVerifyBuilder	withoutExtraFormParameters() Disallows extra parameters (not defined in condition) in form.
HttpClientVerifyBuilder	withoutExtraParameters() Disallows extra parameters (not defined in condition) in query.
HttpClientVerifyBuilder	withParameter(String name, org.hamcrest.Matcher<String> matcher) Adds parameter condition.
HttpClientVerifyBuilder	withParameter(String name, String value) Adds parameter condition.
HttpClientVerifyBuilder	withPath(org.hamcrest.Matcher<String> matcher) Adds path condition.
HttpClientVerifyBuilder	withPath(String path) Adds path condition.
HttpClientVerifyBuilder	withReference(org.hamcrest.Matcher<String> matcher) Adds reference condition.
HttpClientVerifyBuilder	withReference(String reference) Adds reference condition.

Methods inherited from class java.lang.Object

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

Method Detail

withHeader

public HttpClientVerifyBuilder withHeader(String header,
                                          String value)

Adds header condition. Header must be equal to provided value.

Parameters:

header - header name

value - expected value

Returns:

verification builder

withHeader

public HttpClientVerifyBuilder withHeader(String header,
                                          org.hamcrest.Matcher<String> matcher)

Adds header condition. Header must be equal to provided value.

Parameters:

header - header name

matcher - header value matcher

Returns:

verification builder

withReference

public HttpClientVerifyBuilder withReference(String reference)

Adds reference condition. Reference must be equal to provided value.

Parameters:

reference - expected reference

Returns:

conditions builder

withReference

public HttpClientVerifyBuilder withReference(org.hamcrest.Matcher<String> matcher)

Adds reference condition. Reference must match.

Parameters:

matcher - reference matcher

Returns:

conditions builder

withParameter

public HttpClientVerifyBuilder withParameter(String name,
                                             String value)

Adds parameter condition. Parameter must be equal to provided value.

Parameters:

name - parameter name

value - expected parameter value

Returns:

verification builder

withParameter

public HttpClientVerifyBuilder withParameter(String name,
                                             org.hamcrest.Matcher<String> matcher)

Adds parameter condition. Parameter value must match.

Parameters:

name - parameter name

matcher - parameter value matcher

Returns:

verification builder

withFormParameter

public HttpClientVerifyBuilder withFormParameter(String name,
                                                 String value)

Request body must contain the given URL-encoded form parameter (typically found in POST requests). Alternatively, parameters may be specified all at once using withFormParameters(ParametersMatcher).

Parameters:

name - parameter name

value - expected parameter value

Returns:

verification builder

withFormParameter

public HttpClientVerifyBuilder withFormParameter(String name,
                                                 org.hamcrest.Matcher<String> matcher)

Request body must contain the given URL-encoded form parameter (typically found in POST requests). Alternatively, parameters may be specified all at once using withFormParameters(ParametersMatcher).

Parameters:

name - parameter name

matcher - parameter value matcher

Returns:

verification builder

withFormParameters

public HttpClientVerifyBuilder withFormParameters(ParametersMatcher parameters)

Request body must contain the given URL-encoded form parameters (typically used in POST requests). Alternatively, parameters may be specified individually using withFormParameter(String, Matcher).

Parameters:

parameters - the parameters

Returns:

condition builder

with

public HttpClientVerifyBuilder with(Condition condition)

Adds custom conditions.

Parameters:

condition - custom condition

Returns:

verification builder

withBody

public HttpClientVerifyBuilder withBody(org.hamcrest.Matcher<String> matcher)

Adds body condition. Request body must match provided matcher.

Parameters:

matcher - custom condition

Returns:

verification builder

withHost

public HttpClientVerifyBuilder withHost(String host)

Adds host condition. Request host must be equal to provided value.

Parameters:

host - expected host

Returns:

verification builder

withPath

public HttpClientVerifyBuilder withPath(String path)

Adds path condition. Request path must be equal to provided value.

Parameters:

path - expected path

Returns:

verification builder

withPath

public HttpClientVerifyBuilder withPath(org.hamcrest.Matcher<String> matcher)

Adds path condition. Request path must match.

Parameters:

matcher - path matcher

Returns:

verification builder

withExtraParameters

public HttpClientVerifyBuilder withExtraParameters()

Allows extra parameters (not defined in condition) in query.

Returns:

verification builder

withoutExtraParameters

public HttpClientVerifyBuilder withoutExtraParameters()

Disallows extra parameters (not defined in condition) in query.

Returns:

condition builder

withExtraFormParameters

public HttpClientVerifyBuilder withExtraFormParameters()

Allows extra parameters (not defined in condition) in form.

Returns:

verification builder

withoutExtraFormParameters

public HttpClientVerifyBuilder withoutExtraFormParameters()

Disallows extra parameters (not defined in condition) in form.

Returns:

verification builder

notCalled

public void notCalled()

Verifies if there were no request matching defined conditions.

called

public void called()

Verifies if there was exactly one request matching defined conditions.

called

public void called(int numberOfCalls)

Verifies number of request matching defined conditions.

Parameters:

numberOfCalls - expected number of calls

called

public void called(org.hamcrest.Matcher<Integer> numberOfCalls)

Verifies number of request matching defined conditions.

Parameters:

numberOfCalls - expected number of calls