Package io.restassured.module.mockmvc.config

Class RestAssuredMockMvcConfig

java.lang.Object

io.restassured.module.mockmvc.config.RestAssuredMockMvcConfig

All Implemented Interfaces:

SpecificationConfig

public class RestAssuredMockMvcConfig
extends Object
implements SpecificationConfig

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

Usage example:

 RestAssuredMockMvc.config = new RestAssuredMockMvcConfig().logConfig(new LogConfig(captor, true));
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RestAssuredMockMvcConfig	and()	Syntactic sugar.
RestAssuredMockMvcConfig	asyncConfig(AsyncConfig asyncConfig)	Set the async config
SpecificationConfig	clientConfig(ClientConfig clientConfig)
static RestAssuredMockMvcConfig	config()
RestAssuredMockMvcConfig	decoderConfig(io.restassured.config.DecoderConfig decoderConfig)	Set the decoder config
RestAssuredMockMvcConfig	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()
MockMvcConfig	getMockMvcConfig()
MockMvcParamConfig	getMockMvcParamConfig()
io.restassured.config.MultiPartConfig	getMultiPartConfig()
io.restassured.config.ObjectMapperConfig	getObjectMapperConfig()
io.restassured.config.ParamConfig	getParamConfig()
io.restassured.config.SessionConfig	getSessionConfig()
io.restassured.config.XmlConfig	getXmlConfig()
RestAssuredMockMvcConfig	headerConfig(io.restassured.config.HeaderConfig headerConfig)	Set the header config
boolean	isUserConfigured()
RestAssuredMockMvcConfig	jsonConfig(io.restassured.config.JsonConfig jsonConfig)	Set the Json config.
RestAssuredMockMvcConfig	logConfig(io.restassured.config.LogConfig logConfig)	Set the Log config.
RestAssuredMockMvcConfig	matcherConfig(io.restassured.config.MatcherConfig matcherConfig)	Set the matcher config
RestAssuredMockMvcConfig	mockMvcConfig(MockMvcConfig mockMvcConfig)	Set the MockMVC config
RestAssuredMockMvcConfig	multiPartConfig(io.restassured.config.MultiPartConfig multiPartConfig)	Set the multi-part config
static RestAssuredMockMvcConfig	newConfig()
RestAssuredMockMvcConfig	objectMapperConfig(io.restassured.config.ObjectMapperConfig objectMapperConfig)	Set the object mapper config.
SpecificationConfig	paramConfig(io.restassured.config.ParamConfig paramConfig)
RestAssuredMockMvcConfig	paramConfig(MockMvcParamConfig paramConfig)	Set the parameter config
RestAssuredMockMvcConfig	sessionConfig(io.restassured.config.SessionConfig sessionConfig)	Set the session config.
RestAssuredMockMvcConfig	set()	Syntactic sugar.
RestAssuredMockMvcConfig	with()	Syntactic sugar.
RestAssuredMockMvcConfig	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 Details

RestAssuredMockMvcConfig

public RestAssuredMockMvcConfig()

Create a new RestAssuredMockMvcConfig with the default configurations.

Method Details

logConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

sessionConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

objectMapperConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

jsonConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

xmlConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

encoderConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

decoderConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

headerConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

asyncConfig

public RestAssuredMockMvcConfig asyncConfig(AsyncConfig asyncConfig)

Set the async config

Specified by:

asyncConfig in interface SpecificationConfig

Parameters:

asyncConfig - The AsyncConfig to set

Returns:

An updated RestAssuredMockMvcConfig

mockMvcConfig

public RestAssuredMockMvcConfig mockMvcConfig(MockMvcConfig mockMvcConfig)

Set the MockMVC config

Parameters:

mockMvcConfig - The MockMvcConfig to set

Returns:

An updated RestAssuredMockMvcConfig

multiPartConfig

public RestAssuredMockMvcConfig 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 RestAssuredMockMvcConfig

getClientConfig

public ClientConfig getClientConfig()

Specified by:

getClientConfig in interface SpecificationConfig

clientConfig

public SpecificationConfig clientConfig(ClientConfig clientConfig)

Specified by:

clientConfig in interface SpecificationConfig

paramConfig

public RestAssuredMockMvcConfig paramConfig(MockMvcParamConfig paramConfig)

Set the parameter config

Parameters:

paramConfig - The MockMvcParamConfig to set

Returns:

An updated RestAssuredMockMvcConfig

matcherConfig

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

Set the matcher config

Specified by:

matcherConfig in interface SpecificationConfig

Parameters:

matcherConfig - The MockMvcParamConfig to set

Returns:

An updated RestAssuredMockMvcConfig

and

public RestAssuredMockMvcConfig and()

Syntactic sugar.

Returns:

The same RestAssuredMockMvcConfig instance.

set

public RestAssuredMockMvcConfig set()

Syntactic sugar.

Returns:

The same RestAssuredMockMvcConfig instance.

with

public RestAssuredMockMvcConfig with()

Syntactic sugar.

Returns:

The same RestAssuredMockMvcConfig instance.

getLogConfig

public io.restassured.config.LogConfig getLogConfig()

Specified by:

getLogConfig in interface SpecificationConfig

Returns:

The LogConfig

getEncoderConfig

public io.restassured.config.EncoderConfig getEncoderConfig()

Specified by:

getEncoderConfig in interface SpecificationConfig

Returns:

The EncoderConfig

getDecoderConfig

public io.restassured.config.DecoderConfig getDecoderConfig()

Specified by:

getDecoderConfig in interface SpecificationConfig

Returns:

The DecoderConfig

getSessionConfig

public io.restassured.config.SessionConfig getSessionConfig()

Specified by:

getSessionConfig in interface SpecificationConfig

Returns:

The SessionConfig

getObjectMapperConfig

public io.restassured.config.ObjectMapperConfig getObjectMapperConfig()

Specified by:

getObjectMapperConfig in interface SpecificationConfig

Returns:

The ObjectMapperConfig

getJsonConfig

public io.restassured.config.JsonConfig getJsonConfig()

Specified by:

getJsonConfig in interface SpecificationConfig

Returns:

The JsonPath Config

getXmlConfig

public io.restassured.config.XmlConfig getXmlConfig()

Specified by:

getXmlConfig in interface SpecificationConfig

Returns:

The Xml Config

getHeaderConfig

public io.restassured.config.HeaderConfig getHeaderConfig()

Specified by:

getHeaderConfig in interface SpecificationConfig

Returns:

The Header Config

getAsyncConfig

public AsyncConfig getAsyncConfig()

Specified by:

getAsyncConfig in interface SpecificationConfig

Returns:

The MockMvcAsync Config

getMultiPartConfig

public io.restassured.config.MultiPartConfig getMultiPartConfig()

Specified by:

getMultiPartConfig in interface SpecificationConfig

Returns:

The MultiPart Config

getParamConfig

public io.restassured.config.ParamConfig getParamConfig()

Specified by:

getParamConfig in interface SpecificationConfig

Returns:

The Param Config

paramConfig

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

Specified by:

paramConfig in interface SpecificationConfig

getMockMvcParamConfig

public MockMvcParamConfig getMockMvcParamConfig()

getMockMvcConfig

public MockMvcConfig getMockMvcConfig()

Returns:

The MockMvc Config

getMatcherConfig

public io.restassured.config.MatcherConfig getMatcherConfig()

Specified by:

getMatcherConfig in interface SpecificationConfig

Returns:

The Matcher Config

newConfig

public static RestAssuredMockMvcConfig newConfig()

Returns:

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

config

public static RestAssuredMockMvcConfig config()

Returns:

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

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface SpecificationConfig