io.restassured.module.mockmvc.config

Class MockMvcConfig

java.lang.Object

io.restassured.module.mockmvc.config.MockMvcConfig

All Implemented Interfaces:

io.restassured.config.Config, ClientConfig

public class MockMvcConfig
extends Object
implements ClientConfig, io.restassured.config.Config

General configuration of the Spring Mock MVC module

Constructor Summary

Constructors

Constructor and Description
MockMvcConfig() Creates a default MockMvcConfig that automatically applies the SecurityMockMvcConfigurer if available in classpath.

Method Summary

Modifier and Type	Method and Description
MockMvcConfig	automaticallyApplySpringRestDocsMockMvcSupport() Instruct REST Assured Mock Mvc to automatically apply support for spring-restdocs-mockmvc if it's available in the classpath.
MockMvcConfig	automaticallyApplySpringRestDocsMockMvcSupport(boolean automaticallyApplySpringRestDocsMockMvcSupport) Instructs REST Assured whether or not to automatically support spring-restdocs-mockmvc if available in classpath.
MockMvcConfig	automaticallyApplySpringSecurityMockMvcConfigurer() Instruct REST Assured Mock Mvc to automatically apply the SpringSecurityMockMvcConfigurer if it's available in the classpath.
MockMvcConfig	automaticallyApplySpringSecurityMockMvcConfigurer(boolean shouldAutomaticallyApplySpringSecurityMockMvcConfigurer) Instructs REST Assured to automatically apply the SecurityMockMvcConfigurer that allows for Spring Security testing.
MockMvcConfig	dontAutomaticallyApplySpringRestDocsMockMvcSupport() Instruct REST Assured Mock Mvc not to automatically apply support for spring-restdocs-mockmvc even if it's available in the classpath.
MockMvcConfig	dontAutomaticallyApplySpringSecurityMockMvcConfigurer() Instruct REST Assured Mock Mvc not to automatically apply the SpringSecurityMockMvcConfigurer even if it's available in the classpath.
boolean	isUserConfigured()
static MockMvcConfig	mockMvcConfig() Just syntactic sugar.
boolean	shouldAutomaticallyApplySpringRestDocsMockMvcSupport()
boolean	shouldAutomaticallyApplySpringSecurityMockMvcConfigurer()
MockMvcConfig	with() Just syntactic sugar to make the DSL more english like.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockMvcConfig

public MockMvcConfig()

Creates a default MockMvcConfig that automatically applies the SecurityMockMvcConfigurer if available in classpath.

Method Detail

dontAutomaticallyApplySpringSecurityMockMvcConfigurer

public MockMvcConfig dontAutomaticallyApplySpringSecurityMockMvcConfigurer()

Instruct REST Assured Mock Mvc not to automatically apply the SpringSecurityMockMvcConfigurer even if it's available in the classpath.

dontAutomaticallyApplySpringRestDocsMockMvcSupport

public MockMvcConfig dontAutomaticallyApplySpringRestDocsMockMvcSupport()

Instruct REST Assured Mock Mvc not to automatically apply support for spring-restdocs-mockmvc even if it's available in the classpath.

automaticallyApplySpringSecurityMockMvcConfigurer

public MockMvcConfig automaticallyApplySpringSecurityMockMvcConfigurer(boolean shouldAutomaticallyApplySpringSecurityMockMvcConfigurer)

Instructs REST Assured to automatically apply the SecurityMockMvcConfigurer that allows for Spring Security testing. This only works if spring-security-test is in the classpath and you've configured Rest Assured Mock MVC an instance of AbstractMockMvcBuilder. For example by using MockMvcRequestSpecification.webAppContextSetup(WebApplicationContext, MockMvcConfigurer...) or MockMvcRequestSpecification.standaloneSetup(MockMvcBuilder).

Parameters:

shouldAutomaticallyApplySpringSecurityMockMvcConfigurer - true if SecurityMockMvcConfigurer should be automatically applied if available in classpath, false otherwise.

Returns:

a new instance of MockMvcConfig.

automaticallyApplySpringRestDocsMockMvcSupport

public MockMvcConfig automaticallyApplySpringRestDocsMockMvcSupport(boolean automaticallyApplySpringRestDocsMockMvcSupport)

Instructs REST Assured whether or not to automatically support spring-restdocs-mockmvc if available in classpath.

Parameters:

automaticallyApplySpringRestDocsMockMvcSupport - true if Spring Rest Docs MockMvc support should be automatically applied if available in classpath, false otherwise.

Returns:

a new instance of MockMvcConfig.

automaticallyApplySpringSecurityMockMvcConfigurer

public MockMvcConfig automaticallyApplySpringSecurityMockMvcConfigurer()

Instruct REST Assured Mock Mvc to automatically apply the SpringSecurityMockMvcConfigurer if it's available in the classpath.

Returns:

a new instance of MockMvcConfig.

See Also:

automaticallyApplySpringSecurityMockMvcConfigurer(boolean)

automaticallyApplySpringRestDocsMockMvcSupport

public MockMvcConfig automaticallyApplySpringRestDocsMockMvcSupport()

Instruct REST Assured Mock Mvc to automatically apply support for spring-restdocs-mockmvc if it's available in the classpath.

Returns:

a new instance of MockMvcConfig.

See Also:

automaticallyApplySpringRestDocsMockMvcSupport(boolean)

shouldAutomaticallyApplySpringSecurityMockMvcConfigurer

public boolean shouldAutomaticallyApplySpringSecurityMockMvcConfigurer()

Returns:

whether or not REST Assured should automatically try to apply support for Spring Security test if it's available in classpath

shouldAutomaticallyApplySpringRestDocsMockMvcSupport

public boolean shouldAutomaticallyApplySpringRestDocsMockMvcSupport()

Returns:

whether or not REST Assured should automatically try to apply support for spring-restdocs-mockmvc if it's available in classpath

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface io.restassured.config.Config

Specified by:

isUserConfigured in interface ClientConfig

with

public MockMvcConfig with()

Just syntactic sugar to make the DSL more english like.

mockMvcConfig

public static MockMvcConfig mockMvcConfig()

Just syntactic sugar.

Returns:

A new instance of MockMvcConfig.