org.springframework.test.web.servlet.htmlunit.webdriver

Class MockMvcHtmlUnitDriverBuilder

java.lang.Object

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

org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder

public class MockMvcHtmlUnitDriverBuilder
extends MockMvcWebConnectionBuilderSupport<MockMvcHtmlUnitDriverBuilder>

MockMvcHtmlUnitDriverBuilder simplifies the building of an HtmlUnitDriver that delegates to MockMvc and optionally delegates to an actual connection for specific requests.

By default, the driver will delegate to MockMvc to handle requests to localhost and to a WebClient to handle any other URL (i.e. to perform an actual HTTP request).

Since:

4.2

Author:

Rob Winch, Sam Brannen

See Also:

mockMvcSetup(MockMvc), webAppContextSetup(WebApplicationContext), webAppContextSetup(WebApplicationContext, MockMvcConfigurer), javascriptEnabled(boolean), withDelegate(WebConnectionHtmlUnitDriver), build()

Field Summary

Fields

Modifier and Type	Field and Description
private HtmlUnitDriver	driver
private boolean	javascriptEnabled

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockMvcHtmlUnitDriverBuilder(MockMvc mockMvc)
protected	MockMvcHtmlUnitDriverBuilder(WebApplicationContext context)
protected	MockMvcHtmlUnitDriverBuilder(WebApplicationContext context, MockMvcConfigurer configurer)

Method Summary

Modifier and Type	Method and Description
HtmlUnitDriver	build() Build the HtmlUnitDriver configured via this builder.
MockMvcHtmlUnitDriverBuilder	javascriptEnabled(boolean javascriptEnabled) Specify whether JavaScript should be enabled.
static MockMvcHtmlUnitDriverBuilder	mockMvcSetup(MockMvc mockMvc) Create a new MockMvcHtmlUnitDriverBuilder based on the supplied MockMvc instance.
static MockMvcHtmlUnitDriverBuilder	webAppContextSetup(WebApplicationContext context) Create a new MockMvcHtmlUnitDriverBuilder based on the supplied WebApplicationContext.
static MockMvcHtmlUnitDriverBuilder	webAppContextSetup(WebApplicationContext context, MockMvcConfigurer configurer) Create a new MockMvcHtmlUnitDriverBuilder based on the supplied WebApplicationContext and MockMvcConfigurer.
MockMvcHtmlUnitDriverBuilder	withDelegate(WebConnectionHtmlUnitDriver driver) Supply the WebConnectionHtmlUnitDriver that the driver built by this builder should delegate to when processing non-matching requests.

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

Field Detail

driver

private HtmlUnitDriver driver

javascriptEnabled

private boolean javascriptEnabled

Constructor Detail

MockMvcHtmlUnitDriverBuilder

protected MockMvcHtmlUnitDriverBuilder(MockMvc mockMvc)

MockMvcHtmlUnitDriverBuilder

protected MockMvcHtmlUnitDriverBuilder(WebApplicationContext context)

MockMvcHtmlUnitDriverBuilder

protected MockMvcHtmlUnitDriverBuilder(WebApplicationContext context,
                                       MockMvcConfigurer configurer)

Method Detail

mockMvcSetup

public static MockMvcHtmlUnitDriverBuilder mockMvcSetup(MockMvc mockMvc)

Create a new MockMvcHtmlUnitDriverBuilder based on the supplied MockMvc instance.

Parameters:

mockMvc - the MockMvc instance to use; never null

Returns:

the MockMvcHtmlUnitDriverBuilder to customize

webAppContextSetup

public static MockMvcHtmlUnitDriverBuilder webAppContextSetup(WebApplicationContext context)

Create a new MockMvcHtmlUnitDriverBuilder based on the supplied WebApplicationContext.

Parameters:

context - the WebApplicationContext to create a MockMvc instance from; never null

Returns:

the MockMvcHtmlUnitDriverBuilder to customize

webAppContextSetup

public static MockMvcHtmlUnitDriverBuilder webAppContextSetup(WebApplicationContext context,
                                                              MockMvcConfigurer configurer)

Create a new MockMvcHtmlUnitDriverBuilder based on the supplied WebApplicationContext and MockMvcConfigurer.

Parameters:

context - the WebApplicationContext to create a MockMvc instance from; never null

configurer - the MockMvcConfigurer to apply; never null

Returns:

the MockMvcHtmlUnitDriverBuilder to customize

javascriptEnabled

public MockMvcHtmlUnitDriverBuilder javascriptEnabled(boolean javascriptEnabled)

Specify whether JavaScript should be enabled.

Default is true.

Parameters:

javascriptEnabled - true if JavaScript should be enabled

Returns:

this builder for further customizations

See Also:

build()

withDelegate

public MockMvcHtmlUnitDriverBuilder withDelegate(WebConnectionHtmlUnitDriver driver)

Supply the WebConnectionHtmlUnitDriver that the driver built by this builder should delegate to when processing non-matching requests.

Parameters:

driver - the WebConnectionHtmlUnitDriver to delegate to for requests that do not match; never null

Returns:

this builder for further customizations

See Also:

build()

build

public HtmlUnitDriver build()

Build the HtmlUnitDriver configured via this builder.

The returned driver will use the configured MockMvc instance for processing any matching requests and a delegate HtmlUnitDriver for all other requests.

If a delegate has been explicitly configured, it will be used; otherwise, a default WebConnectionHtmlUnitDriver with the BrowserVersion set to CHROME will be configured as the delegate.

Returns:

the HtmlUnitDriver to use

See Also:

withDelegate(WebConnectionHtmlUnitDriver)