com.github.tashoyan.httpspy

Class DefaultRequestExpectationBuilder

java.lang.Object

com.github.tashoyan.httpspy.DefaultRequestExpectationBuilder

All Implemented Interfaces:

RequestExpectationBuilder

@NotThreadSafe
public class DefaultRequestExpectationBuilder
extends Object
implements RequestExpectationBuilder

Default implementation of RequestExpectationBuilder.

TODO Test.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultRequestExpectationBuilder() Creates new builder instance.

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.
protected RequestExpectationBuilder	withRequestAttribute(Function<HttpRequest,Object> attributeProvider, String matcherName, ValueExpectation valueExpectation) Sets expectation on the value of a request attribute.
RequestExpectationBuilder	withStrictHeaders() If the property strict headers is enabled, this expectation allows only headers specified explicitly by RequestExpectationBuilder.withHeader(java.lang.String) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRequestExpectationBuilder

protected DefaultRequestExpectationBuilder()

Creates new builder instance.

New instance matches any request and provides default response from DefaultResponseBuilder.

End user is not supposed to call this constructor and instead should call AbstractRequestExpectationListBuilder.request() when implementing RequestExpectationListBuilder.build().

Method Detail

build

public RequestExpectation build()

Description copied from interface: RequestExpectationBuilder

Builds request expectation.

Specified by:

build in interface RequestExpectationBuilder

Returns:

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

getResponseBuilder

public ResponseBuilder getResponseBuilder()

Description copied from interface: RequestExpectationBuilder

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

Specified by:

getResponseBuilder in interface RequestExpectationBuilder

Returns:

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

withRequestAttribute

protected RequestExpectationBuilder withRequestAttribute(Function<HttpRequest,Object> attributeProvider,
                                                         String matcherName,
                                                         ValueExpectation valueExpectation)

Sets expectation on the value of a request attribute.

Adds a Matcher that verifies the given request attribute.

Parameters:

attributeProvider - Provider of a request attribute, takes the request on input.

matcherName - Name of the matcher to be used in a mismatch description.

valueExpectation - Expected attribute value.

Returns:

This object.

withMethod

public RequestExpectationBuilder withMethod(ValueExpectation valueExpectation)

Description copied from interface: RequestExpectationBuilder

Specifies expected request method.

Specified by:

withMethod in interface RequestExpectationBuilder

Parameters:

valueExpectation - Expected method.

Returns:

This object.

withPath

public RequestExpectationBuilder withPath(ValueExpectation valueExpectation)

Description copied from interface: RequestExpectationBuilder

Specifies expected request path.

Specified by:

withPath in interface RequestExpectationBuilder

Parameters:

valueExpectation - Expected path.

Returns:

This object.

withBody

public RequestExpectationBuilder withBody(ValueExpectation valueExpectation)

Description copied from interface: RequestExpectationBuilder

Specifies expected request body.

Specified by:

withBody in interface RequestExpectationBuilder

Parameters:

valueExpectation - Expected body.

Returns:

This object.

withHeader

public RequestExpectationBuilder withHeader(String headerName)

Description copied from interface: RequestExpectationBuilder

Specifies expected request header without any expectations on its value.

Specified by:

withHeader in interface RequestExpectationBuilder

Parameters:

headerName - Header name.

Returns:

This object.

withHeader

public RequestExpectationBuilder withHeader(String headerName,
                                            ValueExpectation valueExpectation)

Description copied from interface: RequestExpectationBuilder

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

Specified by:

withHeader in interface RequestExpectationBuilder

Parameters:

headerName - Header name.

valueExpectation - Expected header value.

Returns:

This object.

withHeader

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

Description copied from interface: RequestExpectationBuilder

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

Specified by:

withHeader in interface RequestExpectationBuilder

Parameters:

headerName - Header name.

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

valueExpectation - Expected header value.

Returns:

This object.

withoutHeader

public RequestExpectationBuilder withoutHeader(String headerName)

Description copied from interface: RequestExpectationBuilder

Specifies that request is not expected to have this header.

Specified by:

withoutHeader in interface RequestExpectationBuilder

Parameters:

headerName - Header name.

Returns:

This object.

withStrictHeaders

public RequestExpectationBuilder withStrictHeaders()

Description copied from interface: RequestExpectationBuilder

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

By default this property is disabled.

Specified by:

withStrictHeaders in interface RequestExpectationBuilder

Returns:

This object.

andResponse

public RequestExpectationBuilder andResponse(ResponseBuilder responseBuilder)

Description copied from interface: RequestExpectationBuilder

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

Specified by:

andResponse in interface RequestExpectationBuilder

Parameters:

responseBuilder - Response builder.

Returns:

This object.