org.springframework.test.web.servlet.htmlunit

Class HtmlUnitRequestBuilder

java.lang.Object

org.springframework.test.web.servlet.htmlunit.HtmlUnitRequestBuilder

All Implemented Interfaces:

Mergeable, RequestBuilder

final class HtmlUnitRequestBuilder
extends java.lang.Object
implements RequestBuilder, Mergeable

Internal class used to transform a WebRequest into a MockHttpServletRequest using Spring MVC Test's RequestBuilder.

By default the first path segment of the URL is used as the contextPath. To override this default see setContextPath(String).

Since:

4.2

Author:

Rob Winch, Sam Brannen

See Also:

MockMvcWebConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	HtmlUnitRequestBuilder.HtmlUnitMockHttpServletRequest An extension to MockHttpServletRequest that ensures that when a new HttpSession is created, it is added to the managed sessions.
private class	HtmlUnitRequestBuilder.HtmlUnitMockHttpSession An extension to MockHttpSession that ensures when HtmlUnitRequestBuilder.HtmlUnitMockHttpSession.invalidate() is called that the HttpSession is removed from the managed sessions.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	contextPath
private RequestPostProcessor	forwardPostProcessor
private static java.util.regex.Pattern	LOCALE_PATTERN
private RequestBuilder	parentBuilder
private SmartRequestBuilder	parentPostProcessor
private java.util.Map<java.lang.String,MockHttpSession>	sessions
private WebClient	webClient
private WebRequest	webRequest

Constructor Summary

Constructors

Constructor and Description
HtmlUnitRequestBuilder(java.util.Map<java.lang.String,MockHttpSession> sessions, WebClient webClient, WebRequest webRequest) Construct a new HtmlUnitRequestBuilder.

Method Summary

Modifier and Type	Method and Description
private void	addSessionCookie(MockHttpServletRequest request, java.lang.String sessionid)
private void	authType(MockHttpServletRequest request)
MockHttpServletRequest	buildRequest(ServletContext servletContext) Build the request.
private void	content(MockHttpServletRequest request, java.lang.String charset)
private void	contentType(MockHttpServletRequest request)
private void	contextPath(MockHttpServletRequest request, UriComponents uriComponents)
private void	cookies(MockHttpServletRequest request)
private com.gargoylesoftware.htmlunit.util.Cookie	createCookie(MockHttpServletRequest request, java.lang.String sessionid)
private java.lang.String	getCharset()
private CookieManager	getCookieManager()
private java.lang.String	header(java.lang.String headerName)
private void	headers(MockHttpServletRequest request)
private MockHttpSession	httpSession(MockHttpServletRequest request, java.lang.String sessionid)
boolean	isMergeEnabled() Is merging enabled for this particular instance?
private void	locales(MockHttpServletRequest request)
java.lang.Object	merge(java.lang.Object parent) Merge the current value set with that of the supplied object.
private void	params(MockHttpServletRequest request, UriComponents uriComponents)
private void	parent(MockHttpServletRequest request, RequestBuilder parent)
private java.util.Locale	parseLocale(java.lang.String locale)
private void	ports(UriComponents uriComponents, MockHttpServletRequest request)
private MockHttpServletRequest	postProcess(MockHttpServletRequest request)
private void	processCookie(MockHttpServletRequest request, java.util.List<Cookie> cookies, Cookie cookie)
private void	removeSessionCookie(MockHttpServletRequest request, java.lang.String sessionid)
private void	servletPath(MockHttpServletRequest request, java.lang.String requestPath)
private void	servletPath(UriComponents uriComponents, MockHttpServletRequest request)
void	setContextPath(java.lang.String contextPath) Set the contextPath to be used.
void	setForwardPostProcessor(RequestPostProcessor forwardPostProcessor)
private UriComponents	uriComponents()
private java.lang.String	urlDecode(java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_PATTERN

private static final java.util.regex.Pattern LOCALE_PATTERN

sessions

private final java.util.Map<java.lang.String,MockHttpSession> sessions

webClient

private final WebClient webClient

webRequest

private final WebRequest webRequest

contextPath

private java.lang.String contextPath

parentBuilder

private RequestBuilder parentBuilder

parentPostProcessor

private SmartRequestBuilder parentPostProcessor

forwardPostProcessor

private RequestPostProcessor forwardPostProcessor

Constructor Detail

HtmlUnitRequestBuilder

public HtmlUnitRequestBuilder(java.util.Map<java.lang.String,MockHttpSession> sessions,
                              WebClient webClient,
                              WebRequest webRequest)

Construct a new HtmlUnitRequestBuilder.

Parameters:

sessions - a Map from session IDs to currently managed HttpSession objects; never null

webClient - the WebClient for retrieving cookies

webRequest - the WebRequest to transform into a MockHttpServletRequest; never null

Method Detail

buildRequest

public MockHttpServletRequest buildRequest(ServletContext servletContext)

Description copied from interface: RequestBuilder

Build the request.

Specified by:

buildRequest in interface RequestBuilder

Parameters:

servletContext - the ServletContext to use to create the request

Returns:

the request

postProcess

private MockHttpServletRequest postProcess(MockHttpServletRequest request)

parent

private void parent(MockHttpServletRequest request,
                    RequestBuilder parent)

setContextPath

public void setContextPath(java.lang.String contextPath)

Set the contextPath to be used.

The value may be null in which case the first path segment of the URL is turned into the contextPath. Otherwise it must conform to HttpServletRequest#getContextPath() which states it can be an empty string, or it must start with a "/" and not end with a "/".

Parameters:

contextPath - a valid contextPath

Throws:

java.lang.IllegalArgumentException - if the contextPath is not a valid HttpServletRequest#getContextPath()

setForwardPostProcessor

public void setForwardPostProcessor(RequestPostProcessor forwardPostProcessor)

authType

private void authType(MockHttpServletRequest request)

content

private void content(MockHttpServletRequest request,
                     java.lang.String charset)

contentType

private void contentType(MockHttpServletRequest request)

contextPath

private void contextPath(MockHttpServletRequest request,
                         UriComponents uriComponents)

cookies

private void cookies(MockHttpServletRequest request)

processCookie

private void processCookie(MockHttpServletRequest request,
                           java.util.List<Cookie> cookies,
                           Cookie cookie)

getCharset

private java.lang.String getCharset()

header

private java.lang.String header(java.lang.String headerName)

headers

private void headers(MockHttpServletRequest request)

httpSession

private MockHttpSession httpSession(MockHttpServletRequest request,
                                    java.lang.String sessionid)

addSessionCookie

private void addSessionCookie(MockHttpServletRequest request,
                              java.lang.String sessionid)

removeSessionCookie

private void removeSessionCookie(MockHttpServletRequest request,
                                 java.lang.String sessionid)

createCookie

private com.gargoylesoftware.htmlunit.util.Cookie createCookie(MockHttpServletRequest request,
                                                               java.lang.String sessionid)

locales

private void locales(MockHttpServletRequest request)

params

private void params(MockHttpServletRequest request,
                    UriComponents uriComponents)

urlDecode

private java.lang.String urlDecode(java.lang.String value)

parseLocale

private java.util.Locale parseLocale(java.lang.String locale)

servletPath

private void servletPath(MockHttpServletRequest request,
                         java.lang.String requestPath)

servletPath

private void servletPath(UriComponents uriComponents,
                         MockHttpServletRequest request)

ports

private void ports(UriComponents uriComponents,
                   MockHttpServletRequest request)

uriComponents

private UriComponents uriComponents()

isMergeEnabled

public boolean isMergeEnabled()

Description copied from interface: Mergeable

Is merging enabled for this particular instance?

Specified by:

isMergeEnabled in interface Mergeable

merge

public java.lang.Object merge(java.lang.Object parent)

Description copied from interface: Mergeable

Merge the current value set with that of the supplied object.

The supplied object is considered the parent, and values in the callee's value set must override those of the supplied object.

Specified by:

merge in interface Mergeable

Parameters:

parent - the object to merge with

Returns:

the result of the merge operation

getCookieManager

private CookieManager getCookieManager()