Class NetworkInterceptionRequestBuilder<T extends BrowserActionsContract>

java.lang.Object

com.shaft.gui.browser.NetworkInterceptionRequestBuilder<T>

public class NetworkInterceptionRequestBuilder<T extends BrowserActionsContract>
extends Object

Fluent builder for browser network request interception.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NetworkInterceptionRequestBuilder.MockedResponseBuilder<T extends BrowserActionsContract>	Fluent mocked response builder.

Constructor Summary

Constructors

Constructor	Description
NetworkInterceptionRequestBuilder(T browserActions, BiFunction<BrowserNetworkInterceptionRule, String, T> ruleRegistrar)	Creates a request builder backed by the supplied interception rule registrar.

Method Summary

Modifier and Type	Method	Description
T	assertResponse(Consumer<RestValidationsBuilder> validation)	Validates matched real responses with SHAFT hard assertions.
NetworkInterceptionRequestBuilder<T>	bodyContains(String text)	Matches requests whose body contains the given text.
NetworkInterceptionRequestBuilder<T>	delete()
NetworkInterceptionRequestBuilder<T>	get()
NetworkInterceptionRequestBuilder<T>	header(String name, String value)	Matches requests that include the expected header value.
NetworkInterceptionRequestBuilder<T>	matching(Predicate<org.openqa.selenium.remote.http.HttpRequest> predicate)	Adds a custom request predicate.
NetworkInterceptionRequestBuilder<T>	method(org.openqa.selenium.remote.http.HttpMethod method)	Matches requests with the supplied HTTP method.
NetworkInterceptionRequestBuilder<T>	patch()
NetworkInterceptionRequestBuilder<T>	pathContains(String text)	Matches requests whose URL path contains the given text.
NetworkInterceptionRequestBuilder<T>	pathEquals(String path)	Matches requests whose URL path equals the given value.
NetworkInterceptionRequestBuilder<T>	post()
NetworkInterceptionRequestBuilder<T>	put()
NetworkInterceptionRequestBuilder<T>	queryParam(String name, String value)	Matches requests that include the expected query parameter value.
NetworkInterceptionRequestBuilder.MockedResponseBuilder<T>	respond()	Starts building a mocked response for matched requests.
NetworkInterceptionRequestBuilder<T>	urlContains(String text)	Matches requests whose full URL contains the given text.
NetworkInterceptionRequestBuilder<T>	urlMatches(String regex)	Matches requests whose full URL matches the given regular expression.
T	verifyResponse(Consumer<RestValidationsBuilder> validation)	Validates matched real responses with SHAFT soft verifications.

Methods inherited from class Object

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

Constructor Details

NetworkInterceptionRequestBuilder

public NetworkInterceptionRequestBuilder(T browserActions,
 BiFunction<BrowserNetworkInterceptionRule, String, T> ruleRegistrar)

Creates a request builder backed by the supplied interception rule registrar.

Parameters:

browserActions - owning browser actions instance

ruleRegistrar - callback that registers built rules on the owning backend

Method Details

method

public NetworkInterceptionRequestBuilder<T> method(org.openqa.selenium.remote.http.HttpMethod method)

Matches requests with the supplied HTTP method.

Parameters:

method - HTTP method to match

Returns:

this builder

get

public NetworkInterceptionRequestBuilder<T> get()

Returns:

this builder configured to match GET requests

post

public NetworkInterceptionRequestBuilder<T> post()

Returns:

this builder configured to match POST requests

put

public NetworkInterceptionRequestBuilder<T> put()

Returns:

this builder configured to match PUT requests

patch

public NetworkInterceptionRequestBuilder<T> patch()

Returns:

this builder configured to match PATCH requests

delete

public NetworkInterceptionRequestBuilder<T> delete()

Returns:

this builder configured to match DELETE requests

urlContains

public NetworkInterceptionRequestBuilder<T> urlContains(String text)

Matches requests whose full URL contains the given text.

Parameters:

text - URL fragment

Returns:

this builder

urlMatches

public NetworkInterceptionRequestBuilder<T> urlMatches(String regex)

Matches requests whose full URL matches the given regular expression.

Parameters:

regex - URL regular expression

Returns:

this builder

pathEquals

public NetworkInterceptionRequestBuilder<T> pathEquals(String path)

Matches requests whose URL path equals the given value.

Parameters:

path - expected URL path

Returns:

this builder

pathContains

public NetworkInterceptionRequestBuilder<T> pathContains(String text)

Matches requests whose URL path contains the given text.

Parameters:

text - path fragment

Returns:

this builder

queryParam

public NetworkInterceptionRequestBuilder<T> queryParam(String name,
 String value)

Matches requests that include the expected query parameter value.

Parameters:

name - query parameter name

value - expected value

Returns:

this builder

header

public NetworkInterceptionRequestBuilder<T> header(String name,
 String value)

Matches requests that include the expected header value.

Parameters:

name - header name

value - expected value

Returns:

this builder

bodyContains

public NetworkInterceptionRequestBuilder<T> bodyContains(String text)

Matches requests whose body contains the given text.

Parameters:

text - body fragment

Returns:

this builder

matching

public NetworkInterceptionRequestBuilder<T> matching(Predicate<org.openqa.selenium.remote.http.HttpRequest> predicate)

Adds a custom request predicate.

Parameters:

predicate - predicate to apply

Returns:

this builder

respond

public NetworkInterceptionRequestBuilder.MockedResponseBuilder<T> respond()

Starts building a mocked response for matched requests.

Returns:

mocked response builder

assertResponse

public T assertResponse(Consumer<RestValidationsBuilder> validation)

Validates matched real responses with SHAFT hard assertions.

Parameters:

validation - response validation callback

Returns:

the owning browser actions object

verifyResponse

public T verifyResponse(Consumer<RestValidationsBuilder> validation)

Validates matched real responses with SHAFT soft verifications.

Parameters:

validation - response validation callback

Returns:

the owning browser actions object