org.springframework.test.web.servlet.htmlunit

Class MockMvcWebConnectionBuilderSupport<T extends MockMvcWebConnectionBuilderSupport<T>>

java.lang.Object

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

Direct Known Subclasses:

MockMvcHtmlUnitDriverBuilder, MockMvcWebClientBuilder

public abstract class MockMvcWebConnectionBuilderSupport<T extends MockMvcWebConnectionBuilderSupport<T>>
extends java.lang.Object

Makes it easy to create a WebConnection that uses MockMvc and optionally delegates to a real WebConnection for specific requests. The default is to use MockMvc for any host that is "localhost" and otherwise use a real WebConnection.

Since:

1.0

Author:

Rob Winch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockMvcWebConnectionBuilderSupport(org.springframework.test.web.servlet.MockMvc mockMvc) Creates a new instance using a MockMvc instance
protected	MockMvcWebConnectionBuilderSupport(org.springframework.web.context.WebApplicationContext context) Creates a new instance using a WebApplicationContext
protected	MockMvcWebConnectionBuilderSupport(org.springframework.web.context.WebApplicationContext context, org.springframework.test.web.servlet.setup.MockMvcConfigurer configurer) Creates a new instance using a WebApplicationContext

Method Summary

Modifier and Type	Method and Description
T	alwaysUseMockMvc() Always use MockMvc no matter what the request looks like.
T	contextPath(java.lang.String contextPath) The context path to use.
protected com.gargoylesoftware.htmlunit.WebConnection	createConnection(com.gargoylesoftware.htmlunit.WebConnection defaultConnection) Creates a new WebConnection that will use a MockMvc instance if one of the specified WebRequestMatcher matches.
T	useMockMvc(WebRequestMatcher... matchers) Add additional WebRequestMatcher instances that if return true will ensure MockMvc is used.
T	useMockMvcForHosts(java.lang.String... hosts) Add additional WebRequestMatcher instances that will return true if the host matches.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockMvcWebConnectionBuilderSupport

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

Creates a new instance using a MockMvc instance

Parameters:

mockMvc - the MockMvc instance to use. Cannot be null.

MockMvcWebConnectionBuilderSupport

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

Creates a new instance using a WebApplicationContext

Parameters:

context - the WebApplicationContext to create a MockMvc instance from. Cannot be null.

MockMvcWebConnectionBuilderSupport

protected MockMvcWebConnectionBuilderSupport(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.

Method Detail

contextPath

public T contextPath(java.lang.String contextPath)

The context path to use. Default is "". If the value is null, then the first path segment of the request URL is assumed to be the context path.

Parameters:

contextPath - the context path to use.

Returns:

the builder for further customization

alwaysUseMockMvc

public T alwaysUseMockMvc()

Always use MockMvc no matter what the request looks like.

Returns:

the builder for further customization

useMockMvc

public T useMockMvc(WebRequestMatcher... matchers)

Add additional WebRequestMatcher instances that if return true will ensure MockMvc is used.

Parameters:

matchers - the WebRequestMatcher instances that if true will ensure MockMvc processes the request.

Returns:

the builder for further customization

useMockMvcForHosts

public T useMockMvcForHosts(java.lang.String... hosts)

Add additional WebRequestMatcher instances that will return true if the host matches.

Parameters:

hosts - the additional hosts that will ensure MockMvc gets invoked (i.e. example.com or example.com:8080).

Returns:

the builder for further customization

createConnection

protected final com.gargoylesoftware.htmlunit.WebConnection createConnection(com.gargoylesoftware.htmlunit.WebConnection defaultConnection)

Creates a new WebConnection that will use a MockMvc instance if one of the specified WebRequestMatcher matches.

Parameters:

defaultConnection - the default WebConnection to use if none of the specified WebRequestMatcher instances match. Cannot be null.

Returns:

a new WebConnection that will use a MockMvc instance if one of the specified WebRequestMatcher matches.

See Also:

alwaysUseMockMvc, useMockMvc(WebRequestMatcher...), useMockMvcForHosts(String...)