Class NetworkInterceptionRequestBuilder

java.lang.Object

com.shaft.gui.browser.NetworkInterceptionRequestBuilder

public class NetworkInterceptionRequestBuilder
extends Object

Fluent builder for browser network request interception.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NetworkInterceptionRequestBuilder.MockedResponseBuilder	Fluent mocked response builder.

Method Summary

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

Method Details

method

public NetworkInterceptionRequestBuilder 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 get()

Returns:

this builder configured to match GET requests

post

public NetworkInterceptionRequestBuilder post()

Returns:

this builder configured to match POST requests

put

public NetworkInterceptionRequestBuilder put()

Returns:

this builder configured to match PUT requests

patch

public NetworkInterceptionRequestBuilder patch()

Returns:

this builder configured to match PATCH requests

delete

public NetworkInterceptionRequestBuilder delete()

Returns:

this builder configured to match DELETE requests

urlContains

public NetworkInterceptionRequestBuilder urlContains(String text)

Matches requests whose full URL contains the given text.

Parameters:

text - URL fragment

Returns:

this builder

urlMatches

public NetworkInterceptionRequestBuilder urlMatches(String regex)

Matches requests whose full URL matches the given regular expression.

Parameters:

regex - URL regular expression

Returns:

this builder

pathEquals

public NetworkInterceptionRequestBuilder pathEquals(String path)

Matches requests whose URL path equals the given value.

Parameters:

path - expected URL path

Returns:

this builder

pathContains

public NetworkInterceptionRequestBuilder pathContains(String text)

Matches requests whose URL path contains the given text.

Parameters:

text - path fragment

Returns:

this builder

queryParam

public NetworkInterceptionRequestBuilder 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 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 bodyContains(String text)

Matches requests whose body contains the given text.

Parameters:

text - body fragment

Returns:

this builder

matching

public NetworkInterceptionRequestBuilder 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 respond()

Starts building a mocked response for matched requests.

Returns:

mocked response builder

assertResponse

public BrowserActions 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 BrowserActions verifyResponse(Consumer<RestValidationsBuilder> validation)

Validates matched real responses with SHAFT soft verifications.

Parameters:

validation - response validation callback

Returns:

the owning browser actions object