org.springframework.test.web.servlet.htmlunit

Class MockMvcWebClientBuilder

java.lang.Object

org.springframework.test.web.servlet.htmlunit.MockMvcWebConnectionBuilderSupport<MockMvcWebClientBuilder>

org.springframework.test.web.servlet.htmlunit.MockMvcWebClientBuilder

public class MockMvcWebClientBuilder
extends MockMvcWebConnectionBuilderSupport<MockMvcWebClientBuilder>

Simplifies creating a WebClient that delegates to a MockMvc instance.

Since:

1.0

Author:

Rob Winch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockMvcWebClientBuilder(org.springframework.test.web.servlet.MockMvc mockMvc)
protected	MockMvcWebClientBuilder(org.springframework.web.context.WebApplicationContext context)
protected	MockMvcWebClientBuilder(org.springframework.web.context.WebApplicationContext context, org.springframework.test.web.servlet.setup.MockMvcConfigurer configurer)

Method Summary

Modifier and Type	Method and Description
com.gargoylesoftware.htmlunit.WebClient	configureWebClient(com.gargoylesoftware.htmlunit.WebClient webClient) Creates a WebClient that uses the provided MockMvc for any matching requests and the provided WebClient for any other request.
com.gargoylesoftware.htmlunit.WebClient	createWebClient() Creates a WebClient that uses the provided MockMvc for any matching requests and a WebClient with all the default settings for any other request.
static MockMvcWebClientBuilder	mockMvcSetup(org.springframework.test.web.servlet.MockMvc mockMvc) Creates a new instance with a MockMvc instance.
static MockMvcWebClientBuilder	webAppContextSetup(org.springframework.web.context.WebApplicationContext context) Creates a new instance with a WebApplicationContext.
static MockMvcWebClientBuilder	webAppContextSetup(org.springframework.web.context.WebApplicationContext context, org.springframework.test.web.servlet.setup.MockMvcConfigurer configurer) Creates a new instance using a WebApplicationContext

Methods inherited from class org.springframework.test.web.servlet.htmlunit.MockMvcWebConnectionBuilderSupport

alwaysUseMockMvc, contextPath, createConnection, useMockMvc, useMockMvcForHosts

Methods inherited from class java.lang.Object

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

Constructor Detail

MockMvcWebClientBuilder

protected MockMvcWebClientBuilder(org.springframework.test.web.servlet.MockMvc mockMvc)

MockMvcWebClientBuilder

protected MockMvcWebClientBuilder(org.springframework.web.context.WebApplicationContext context)

MockMvcWebClientBuilder

protected MockMvcWebClientBuilder(org.springframework.web.context.WebApplicationContext context,
                                  org.springframework.test.web.servlet.setup.MockMvcConfigurer configurer)

Method Detail

webAppContextSetup

public static MockMvcWebClientBuilder webAppContextSetup(org.springframework.web.context.WebApplicationContext context)

Creates a new instance with a WebApplicationContext.

Parameters:

context - the WebApplicationContext to use. Cannot be null.

Returns:

the MockMvcWebClientBuilder to customize

webAppContextSetup

public static MockMvcWebClientBuilder webAppContextSetup(org.springframework.web.context.WebApplicationContext context,
                                                         org.springframework.test.web.servlet.setup.MockMvcConfigurer configurer)

Creates a new instance using a WebApplicationContext

Parameters:

context - the WebApplicationContext to create a MockMvc instance from.

configurer - the MockMvcConfigurer to apply Cannot be null.

Returns:

the MockMvcWebClientBuilder to use

mockMvcSetup

public static MockMvcWebClientBuilder mockMvcSetup(org.springframework.test.web.servlet.MockMvc mockMvc)

Creates a new instance with a MockMvc instance.

Parameters:

mockMvc - the MockMvc to use. Cannot be null.

Returns:

the MockMvcWebClientBuilder to customize

createWebClient

public com.gargoylesoftware.htmlunit.WebClient createWebClient()

Creates a WebClient that uses the provided MockMvc for any matching requests and a WebClient with all the default settings for any other request.

Returns:

the WebClient to use

configureWebClient

public com.gargoylesoftware.htmlunit.WebClient configureWebClient(com.gargoylesoftware.htmlunit.WebClient webClient)

Creates a WebClient that uses the provided MockMvc for any matching requests and the provided WebClient for any other request.

Parameters:

webClient - The WebClient to delegate to for requests that do not match. Cannot be null.

Returns:

the WebClient to use