io.restassured.module.webtestclient.config

Class RestAssuredWebTestClientConfig

java.lang.Object

io.restassured.module.webtestclient.config.RestAssuredWebTestClientConfig

All Implemented Interfaces:

SpecificationConfig

public class RestAssuredWebTestClientConfig
extends Object
implements SpecificationConfig

Main configuration for REST Assured WebTestClient that allows you to configure advanced settings.

Usage example:

 RestAssuredWebTestClient.config = new RestAssuredWebTestClientConfig().logConfig(new LogConfig(captor, true));
 

Constructor Summary

Constructors

Constructor and Description
RestAssuredWebTestClientConfig() Create a new RestAssuredWebTestClientConfig with the default configurations.

Method Summary

Modifier and Type	Method and Description
RestAssuredWebTestClientConfig	and() Syntactic sugar.
RestAssuredWebTestClientConfig	asyncConfig(AsyncConfig asyncConfig) Set the async config
RestAssuredWebTestClientConfig	clientConfig(ClientConfig clientConfig)
static RestAssuredWebTestClientConfig	config()
RestAssuredWebTestClientConfig	decoderConfig(io.restassured.config.DecoderConfig decoderConfig) Set the decoder config
RestAssuredWebTestClientConfig	encoderConfig(io.restassured.config.EncoderConfig encoderConfig) Set the encoder config
AsyncConfig	getAsyncConfig()
ClientConfig	getClientConfig()
io.restassured.config.DecoderConfig	getDecoderConfig()
io.restassured.config.EncoderConfig	getEncoderConfig()
io.restassured.config.HeaderConfig	getHeaderConfig()
io.restassured.config.JsonConfig	getJsonConfig()
io.restassured.config.LogConfig	getLogConfig()
io.restassured.config.MatcherConfig	getMatcherConfig()
io.restassured.config.MultiPartConfig	getMultiPartConfig()
io.restassured.config.ObjectMapperConfig	getObjectMapperConfig()
io.restassured.config.ParamConfig	getParamConfig()
io.restassured.config.SessionConfig	getSessionConfig()
WebTestClientConfig	getWebTestClientConfig()
WebTestClientParamConfig	getWebTestClientParamConfig()
io.restassured.config.XmlConfig	getXmlConfig()
RestAssuredWebTestClientConfig	headerConfig(io.restassured.config.HeaderConfig headerConfig) Set the header config
boolean	isUserConfigured()
RestAssuredWebTestClientConfig	jsonConfig(io.restassured.config.JsonConfig jsonConfig) Set the Json config.
RestAssuredWebTestClientConfig	logConfig(io.restassured.config.LogConfig logConfig) Set the Log config.
RestAssuredWebTestClientConfig	matcherConfig(io.restassured.config.MatcherConfig matcherConfig) Set the matcher config.
RestAssuredWebTestClientConfig	multiPartConfig(io.restassured.config.MultiPartConfig multiPartConfig) Set the multi-part config
static RestAssuredWebTestClientConfig	newConfig()
RestAssuredWebTestClientConfig	objectMapperConfig(io.restassured.config.ObjectMapperConfig objectMapperConfig) Set the object mapper config.
SpecificationConfig	paramConfig(io.restassured.config.ParamConfig paramConfig)
RestAssuredWebTestClientConfig	paramConfig(WebTestClientParamConfig paramConfig) Set the parameter config
RestAssuredWebTestClientConfig	sessionConfig(io.restassured.config.SessionConfig sessionConfig) Set the session config.
RestAssuredWebTestClientConfig	set() Syntactic sugar.
RestAssuredWebTestClientConfig	webTestClientConfig(WebTestClientConfig webTestClientConfig) Set the webTestClient config
RestAssuredWebTestClientConfig	with() Syntactic sugar.
RestAssuredWebTestClientConfig	xmlConfig(io.restassured.config.XmlConfig xmlConfig) Set the Xml config.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAssuredWebTestClientConfig

public RestAssuredWebTestClientConfig()

Create a new RestAssuredWebTestClientConfig with the default configurations.

Method Detail

newConfig

public static RestAssuredWebTestClientConfig newConfig()

Returns:

A static way to create a new RestAssuredWebTestClientConfiguration instance without calling "new" explicitly. Mainly for syntactic sugar.

config

public static RestAssuredWebTestClientConfig config()

Returns:

A static way to create a new RestAssuredWebTestClientConfiguration instance without calling "new" explicitly. Mainly for syntactic sugar.

and

public RestAssuredWebTestClientConfig and()

Syntactic sugar.

Returns:

The same RestAssuredWebTestClientConfig instance.

set

public RestAssuredWebTestClientConfig set()

Syntactic sugar.

Returns:

The same RestAssuredWebTestClientConfig instance.

with

public RestAssuredWebTestClientConfig with()

Syntactic sugar.

Returns:

The same RestAssuredWebTestClientConfig instance.

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface SpecificationConfig

getDecoderConfig

public io.restassured.config.DecoderConfig getDecoderConfig()

Specified by:

getDecoderConfig in interface SpecificationConfig

Returns:

The DecoderConfig

decoderConfig

public RestAssuredWebTestClientConfig decoderConfig(io.restassured.config.DecoderConfig decoderConfig)

Set the decoder config

Specified by:

decoderConfig in interface SpecificationConfig

Parameters:

decoderConfig - The DecoderConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getEncoderConfig

public io.restassured.config.EncoderConfig getEncoderConfig()

Specified by:

getEncoderConfig in interface SpecificationConfig

Returns:

The EncoderConfig

encoderConfig

public RestAssuredWebTestClientConfig encoderConfig(io.restassured.config.EncoderConfig encoderConfig)

Set the encoder config

Specified by:

encoderConfig in interface SpecificationConfig

Parameters:

encoderConfig - The EncoderConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getHeaderConfig

public io.restassured.config.HeaderConfig getHeaderConfig()

Specified by:

getHeaderConfig in interface SpecificationConfig

Returns:

The Header Config

headerConfig

public RestAssuredWebTestClientConfig headerConfig(io.restassured.config.HeaderConfig headerConfig)

Set the header config

Specified by:

headerConfig in interface SpecificationConfig

Parameters:

headerConfig - The HeaderConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getJsonConfig

public io.restassured.config.JsonConfig getJsonConfig()

Specified by:

getJsonConfig in interface SpecificationConfig

Returns:

The JsonPath Config

jsonConfig

public RestAssuredWebTestClientConfig jsonConfig(io.restassured.config.JsonConfig jsonConfig)

Set the Json config.

Specified by:

jsonConfig in interface SpecificationConfig

Parameters:

jsonConfig - The JsonConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getLogConfig

public io.restassured.config.LogConfig getLogConfig()

Specified by:

getLogConfig in interface SpecificationConfig

Returns:

The LogConfig

logConfig

public RestAssuredWebTestClientConfig logConfig(io.restassured.config.LogConfig logConfig)

Set the Log config.

Specified by:

logConfig in interface SpecificationConfig

Parameters:

logConfig - The LogConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getObjectMapperConfig

public io.restassured.config.ObjectMapperConfig getObjectMapperConfig()

Specified by:

getObjectMapperConfig in interface SpecificationConfig

Returns:

The ObjectMapperConfig

objectMapperConfig

public RestAssuredWebTestClientConfig objectMapperConfig(io.restassured.config.ObjectMapperConfig objectMapperConfig)

Set the object mapper config.

Specified by:

objectMapperConfig in interface SpecificationConfig

Parameters:

objectMapperConfig - The ObjectMapperConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getSessionConfig

public io.restassured.config.SessionConfig getSessionConfig()

Specified by:

getSessionConfig in interface SpecificationConfig

Returns:

The SessionConfig

sessionConfig

public RestAssuredWebTestClientConfig sessionConfig(io.restassured.config.SessionConfig sessionConfig)

Set the session config.

Specified by:

sessionConfig in interface SpecificationConfig

Parameters:

sessionConfig - The SessionConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getXmlConfig

public io.restassured.config.XmlConfig getXmlConfig()

Specified by:

getXmlConfig in interface SpecificationConfig

Returns:

The Xml Config

xmlConfig

public RestAssuredWebTestClientConfig xmlConfig(io.restassured.config.XmlConfig xmlConfig)

Set the Xml config.

Specified by:

xmlConfig in interface SpecificationConfig

Parameters:

xmlConfig - The XmlConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getAsyncConfig

public AsyncConfig getAsyncConfig()

Specified by:

getAsyncConfig in interface SpecificationConfig

Returns:

The WebTestClientAsync Config

asyncConfig

public RestAssuredWebTestClientConfig asyncConfig(AsyncConfig asyncConfig)

Set the async config

Specified by:

asyncConfig in interface SpecificationConfig

Parameters:

asyncConfig - The AsyncConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getMultiPartConfig

public io.restassured.config.MultiPartConfig getMultiPartConfig()

Specified by:

getMultiPartConfig in interface SpecificationConfig

Returns:

The MultiPart Config

multiPartConfig

public RestAssuredWebTestClientConfig multiPartConfig(io.restassured.config.MultiPartConfig multiPartConfig)

Set the multi-part config

Specified by:

multiPartConfig in interface SpecificationConfig

Parameters:

multiPartConfig - The MultiPartConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getClientConfig

public ClientConfig getClientConfig()

Specified by:

getClientConfig in interface SpecificationConfig

clientConfig

public RestAssuredWebTestClientConfig clientConfig(ClientConfig clientConfig)

Specified by:

clientConfig in interface SpecificationConfig

webTestClientConfig

public RestAssuredWebTestClientConfig webTestClientConfig(WebTestClientConfig webTestClientConfig)

Set the webTestClient config

Parameters:

webTestClientConfig - The WebTestClientConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getParamConfig

public io.restassured.config.ParamConfig getParamConfig()

Specified by:

getParamConfig in interface SpecificationConfig

Returns:

The Param Config

getWebTestClientParamConfig

public WebTestClientParamConfig getWebTestClientParamConfig()

paramConfig

public SpecificationConfig paramConfig(io.restassured.config.ParamConfig paramConfig)

Specified by:

paramConfig in interface SpecificationConfig

paramConfig

public RestAssuredWebTestClientConfig paramConfig(WebTestClientParamConfig paramConfig)

Set the parameter config

Parameters:

paramConfig - The WebTestClientParamConfig to set

Returns:

An updated RestAssuredWebTestClientConfig

getWebTestClientConfig

public WebTestClientConfig getWebTestClientConfig()

Returns:

The WebTestClient Config

getMatcherConfig

public io.restassured.config.MatcherConfig getMatcherConfig()

Specified by:

getMatcherConfig in interface SpecificationConfig

Returns:

The MatcherConfig

matcherConfig

public RestAssuredWebTestClientConfig matcherConfig(io.restassured.config.MatcherConfig matcherConfig)

Set the matcher config.

Specified by:

matcherConfig in interface SpecificationConfig

Parameters:

matcherConfig - The MatcherConfig to set

Returns:

An updated RestAssuredWebTestClientConfig