com.github.tashoyan.httpspy

Interface RequestExpectationBuilder

All Known Implementing Classes:

DefaultRequestExpectationBuilder

@NotThreadSafe
public interface RequestExpectationBuilder

Request expectation builder.

Builds a request expectation object after properties are set.

Concurrency notes. Builder instances are used in a single thread that prepares requests expectations - typically main thread. Implementations are not required to be thread safe.

Method Summary

Modifier and Type	Method and Description
RequestExpectationBuilder	andResponse(ResponseBuilder responseBuilder) Specifies response builder to provide a response on the actual request.
RequestExpectation	build() Builds request expectation.
ResponseBuilder	getResponseBuilder() Gets response builder to provide a response on the actual request.
RequestExpectationBuilder	withBody(ValueExpectation valueExpectation) Specifies expected request body.
RequestExpectationBuilder	withHeader(String headerName) Specifies expected request header without any expectations on its value.
RequestExpectationBuilder	withHeader(String headerName, int valueIndex, ValueExpectation valueExpectation) Specifies expected request header with its value and position in the list of header values.
RequestExpectationBuilder	withHeader(String headerName, ValueExpectation valueExpectation) Specifies expected request header with its value, but without position in the list of header values.
RequestExpectationBuilder	withMethod(ValueExpectation valueExpectation) Specifies expected request method.
RequestExpectationBuilder	withoutHeader(String headerName) Specifies that request is not expected to have this header.
RequestExpectationBuilder	withPath(ValueExpectation valueExpectation) Specifies expected request path.
RequestExpectationBuilder	withStrictHeaders() If the property strict headers is enabled, this expectation allows only headers specified explicitly by withHeader(java.lang.String) method.

Method Detail

build

RequestExpectation build()

Builds request expectation.

Returns:

Request expectation. Should not return null, if none parameters set then should return default request expectation that matches any request.

getResponseBuilder

ResponseBuilder getResponseBuilder()

Gets response builder to provide a response on the actual request.

Returns:

Response builder. Should not return null. If not set, then should return a builder that provides default response.

withMethod

RequestExpectationBuilder withMethod(ValueExpectation valueExpectation)

Specifies expected request method.

Parameters:

valueExpectation - Expected method.

Returns:

This object.

Throws:

NullPointerException - valueExpectation is null.

withPath

RequestExpectationBuilder withPath(ValueExpectation valueExpectation)

Specifies expected request path.

Parameters:

valueExpectation - Expected path.

Returns:

This object.

Throws:

NullPointerException - valueExpectation is null.

withBody

RequestExpectationBuilder withBody(ValueExpectation valueExpectation)

Specifies expected request body.

Parameters:

valueExpectation - Expected body.

Returns:

This object.

Throws:

NullPointerException - valueExpectation is null.

withHeader

RequestExpectationBuilder withHeader(String headerName)

Specifies expected request header without any expectations on its value.

Parameters:

headerName - Header name.

Returns:

This object.

Throws:

NullPointerException - headerName is null.

IllegalArgumentException - headerName is empty or blank.

withHeader

RequestExpectationBuilder withHeader(String headerName,
                                     ValueExpectation valueExpectation)

Specifies expected request header with its value, but without position in the list of header values.

Parameters:

headerName - Header name.

valueExpectation - Expected header value.

Returns:

This object.

Throws:

NullPointerException - valueExpectation is null.

NullPointerException - headerName is null.

IllegalArgumentException - headerName is empty or blank.

withHeader

RequestExpectationBuilder withHeader(String headerName,
                                     int valueIndex,
                                     ValueExpectation valueExpectation)

Specifies expected request header with its value and position in the list of header values.

Parameters:

headerName - Header name.

valueIndex - Header value index in the list of header values.

valueExpectation - Expected header value.

Returns:

This object.

Throws:

NullPointerException - valueExpectation is null.

NullPointerException - headerName is null.

IllegalArgumentException - headerName is empty or blank.

IllegalArgumentException - valueIndex is negative.

withoutHeader

RequestExpectationBuilder withoutHeader(String headerName)

Specifies that request is not expected to have this header.

Parameters:

headerName - Header name.

Returns:

This object.

Throws:

NullPointerException - headerName is null.

IllegalArgumentException - headerName is empty or blank.

withStrictHeaders

RequestExpectationBuilder withStrictHeaders()

If the property strict headers is enabled, this expectation allows only headers specified explicitly by withHeader(java.lang.String) method.

By default this property is disabled.

Returns:

This object.

andResponse

RequestExpectationBuilder andResponse(ResponseBuilder responseBuilder)

Specifies response builder to provide a response on the actual request.

Parameters:

responseBuilder - Response builder.

Returns:

This object.

Throws:

NullPointerException - responseBuilder is null.