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>
MockMvcWebClientBuildersimplifies the creation of an HtmlUnitWebClientthat delegates to aMockMvcinstance.The
MockMvcinstance used by the builder may be supplied directly or created transparently from aWebApplicationContext.- Since:
- 4.2
- Author:
- Rob Winch, Sam Brannen
- See Also:
mockMvcSetup(MockMvc),webAppContextSetup(WebApplicationContext),webAppContextSetup(WebApplicationContext, MockMvcConfigurer),withDelegate(WebClient),build()
Constructor Summary
Constructors Modifier Constructor Description protectedMockMvcWebClientBuilder(MockMvc mockMvc)protectedMockMvcWebClientBuilder(WebApplicationContext context)protectedMockMvcWebClientBuilder(WebApplicationContext context, MockMvcConfigurer configurer)
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.gargoylesoftware.htmlunit.WebClientbuild()Build theWebClientconfigured via this builder.static MockMvcWebClientBuildermockMvcSetup(MockMvc mockMvc)Create a newMockMvcWebClientBuilderbased on the suppliedMockMvcinstance.static MockMvcWebClientBuilderwebAppContextSetup(WebApplicationContext context)Create a newMockMvcWebClientBuilderbased on the suppliedWebApplicationContext.static MockMvcWebClientBuilderwebAppContextSetup(WebApplicationContext context, MockMvcConfigurer configurer)Create a newMockMvcWebClientBuilderbased on the suppliedWebApplicationContextandMockMvcConfigurer.MockMvcWebClientBuilderwithDelegate(com.gargoylesoftware.htmlunit.WebClient webClient)Methods inherited from class org.springframework.test.web.servlet.htmlunit.MockMvcWebConnectionBuilderSupport
alwaysUseMockMvc, contextPath, createConnection, createConnection, useMockMvc, useMockMvcForHosts
Constructor Detail
MockMvcWebClientBuilder
protected MockMvcWebClientBuilder(MockMvc mockMvc)
MockMvcWebClientBuilder
protected MockMvcWebClientBuilder(WebApplicationContext context)
MockMvcWebClientBuilder
protected MockMvcWebClientBuilder(WebApplicationContext context, MockMvcConfigurer configurer)
Method Detail
mockMvcSetup
public static MockMvcWebClientBuilder mockMvcSetup(MockMvc mockMvc)
Create a newMockMvcWebClientBuilderbased on the suppliedMockMvcinstance.- Parameters:
mockMvc- theMockMvcinstance to use; nevernull- Returns:
- the MockMvcWebClientBuilder to customize
webAppContextSetup
public static MockMvcWebClientBuilder webAppContextSetup(WebApplicationContext context)
Create a newMockMvcWebClientBuilderbased on the suppliedWebApplicationContext.- Parameters:
context- theWebApplicationContextto create aMockMvcinstance from; nevernull- Returns:
- the MockMvcWebClientBuilder to customize
webAppContextSetup
public static MockMvcWebClientBuilder webAppContextSetup(WebApplicationContext context, MockMvcConfigurer configurer)
Create a newMockMvcWebClientBuilderbased on the suppliedWebApplicationContextandMockMvcConfigurer.- Parameters:
context- theWebApplicationContextto create aMockMvcinstance from; nevernullconfigurer- theMockMvcConfigurerto apply; nevernull- Returns:
- the MockMvcWebClientBuilder to customize
withDelegate
public MockMvcWebClientBuilder withDelegate(com.gargoylesoftware.htmlunit.WebClient webClient)
Supply theWebClientthat the client built by this builder should delegate to when processing non-matching requests.- Parameters:
webClient- theWebClientto delegate to for requests that do not match; nevernull- Returns:
- this builder for further customization
- See Also:
build()
build
public com.gargoylesoftware.htmlunit.WebClient build()
Build theWebClientconfigured via this builder.The returned client will use the configured
MockMvcinstance for processing any matching requests and a delegateWebClientfor all other requests.If a delegate has been explicitly configured, it will be used; otherwise, a default
WebClientwill be configured as the delegate.- Returns:
- the
WebClientto use - See Also:
withDelegate(WebClient)