io.specto.hoverfly.junit.dsl

Class RequestMatcherBuilder

java.lang.Object

io.specto.hoverfly.junit.dsl.RequestMatcherBuilder

public class RequestMatcherBuilder
extends java.lang.Object

A builder for Request

Method Summary

Modifier and Type	Method and Description
RequestMatcherBuilder	anyBody()
RequestMatcherBuilder	anyQueryParams() Add a matcher that matches any query parameters
RequestMatcherBuilder	body(HttpBodyConverter httpBodyConverter) Sets the request body using HttpBodyConverter to match on exactly
RequestMatcherBuilder	body(RequestFieldMatcher matcher)
RequestMatcherBuilder	body(java.lang.String body) Sets the request body
Request	build()
RequestMatcherBuilder	header(java.lang.String key, java.lang.Object... values) Add a header matcher
RequestMatcherBuilder	header(java.lang.String key, RequestFieldMatcher matcher) Add a header matcher
RequestMatcherBuilder	queryParam(java.lang.String key, java.lang.Object... values) Add a query matcher
RequestMatcherBuilder	queryParam(java.lang.String key, RequestFieldMatcher matcher) Add a query matcher
StubServiceBuilder	willReturn(ResponseBuilder responseBuilder) Sets the expected response
RequestMatcherBuilder	withState(java.lang.String key, java.lang.String value) Sets a required state

Methods inherited from class java.lang.Object

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

Method Detail

body

public RequestMatcherBuilder body(java.lang.String body)

Sets the request body

Parameters:

body - the request body to match on exactly

Returns:

the RequestMatcherBuilder for further customizations

body

public RequestMatcherBuilder body(HttpBodyConverter httpBodyConverter)

Sets the request body using HttpBodyConverter to match on exactly

Parameters:

httpBodyConverter - custom http body converter

Returns:

the RequestMatcherBuilder for further customizations

body

public RequestMatcherBuilder body(RequestFieldMatcher matcher)

anyBody

public RequestMatcherBuilder anyBody()

header

public RequestMatcherBuilder header(java.lang.String key,
                                    java.lang.Object... values)

Add a header matcher

Parameters:

key - the header key to match on

values - the header values to match on

Returns:

the RequestMatcherBuilder for further customizations

header

public RequestMatcherBuilder header(java.lang.String key,
                                    RequestFieldMatcher matcher)

Add a header matcher

Parameters:

key - the header key to match on

matcher - the matcher for matching header values

Returns:

the RequestMatcherBuilder for further customizations

withState

public RequestMatcherBuilder withState(java.lang.String key,
                                       java.lang.String value)

Sets a required state

Parameters:

key - state key

value - state value

Returns:

the RequestMatcherBuilder for further customizations

queryParam

public RequestMatcherBuilder queryParam(java.lang.String key,
                                        java.lang.Object... values)

Add a query matcher

Parameters:

key - the query params key to match on

values - the query params values to match on

Returns:

the RequestMatcherBuilder for further customizations

queryParam

public RequestMatcherBuilder queryParam(java.lang.String key,
                                        RequestFieldMatcher matcher)

Add a query matcher

Parameters:

key - the query params key to match on

matcher - the matcher for matching query parameter values

Returns:

the RequestMatcherBuilder for further customizations

anyQueryParams

public RequestMatcherBuilder anyQueryParams()

Add a matcher that matches any query parameters

Returns:

the RequestMatcherBuilder for further customizations

willReturn

public StubServiceBuilder willReturn(ResponseBuilder responseBuilder)

Sets the expected response

Parameters:

responseBuilder - the builder for response

Returns:

the StubServiceBuilder for chaining the next RequestMatcherBuilder

See Also:

ResponseBuilder

build

public Request build()