org.springframework.test.web.servlet.request

Class MockHttpServletRequestBuilder

java.lang.Object

org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder

All Implemented Interfaces:

Mergeable, ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>, RequestBuilder, SmartRequestBuilder

Direct Known Subclasses:

MockMultipartHttpServletRequestBuilder

public class MockHttpServletRequestBuilder
extends java.lang.Object
implements ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>, Mergeable

Default builder for MockHttpServletRequest required as input to perform requests in MockMvc.

Application tests will typically access this builder through the static factory methods in MockMvcRequestBuilders.

Since:

3.2

Author:

Rossen Stoyanchev, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private java.lang.String	characterEncoding
private byte[]	content
private java.lang.String	contentType
private java.lang.String	contextPath
private java.util.List<Cookie>	cookies
private java.util.Map<java.lang.String,java.lang.Object>	flashAttributes
private MultiValueMap<java.lang.String,java.lang.Object>	headers
private java.util.Locale	locale
private HttpMethod	method
private MultiValueMap<java.lang.String,java.lang.String>	parameters
private java.lang.String	pathInfo
private java.util.List<RequestPostProcessor>	postProcessors
private java.security.Principal	principal
private java.lang.Boolean	secure
private java.lang.String	servletPath
private MockHttpSession	session
private java.util.Map<java.lang.String,java.lang.Object>	sessionAttributes
private UriComponents	uriComponents

Constructor Summary

Constructors

Constructor and Description
MockHttpServletRequestBuilder(HttpMethod httpMethod, java.lang.String urlTemplate, java.lang.Object... urlVariables) Package private constructor.
MockHttpServletRequestBuilder(HttpMethod httpMethod, java.net.URI uri) Package private constructor.

Method Summary

Modifier and Type	Method and Description
MockHttpServletRequestBuilder	accept(MediaType... mediaTypes) Set the 'Accept' header to the given media type(s).
MockHttpServletRequestBuilder	accept(java.lang.String... mediaTypes) Set the 'Accept' header to the given media type(s).
private static void	addAttributeToMap(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String name, java.lang.Object value)
private static <T> void	addToMultiValueMap(MultiValueMap<java.lang.String,T> map, java.lang.String name, T[] values)
MockHttpServletRequest	buildRequest(ServletContext servletContext) Build a MockHttpServletRequest.
MockHttpServletRequestBuilder	characterEncoding(java.lang.String encoding) Set the character encoding of the request.
private boolean	containsCookie(Cookie cookie)
MockHttpServletRequestBuilder	content(byte[] content) Set the request body.
MockHttpServletRequestBuilder	content(java.lang.String content) Set the request body as a UTF-8 String.
MockHttpServletRequestBuilder	contentType(MediaType contentType) Set the 'Content-Type' header of the request.
MockHttpServletRequestBuilder	contentType(java.lang.String contentType) Set the 'Content-Type' header of the request.
MockHttpServletRequestBuilder	contextPath(java.lang.String contextPath) Specify the portion of the requestURI that represents the context path.
MockHttpServletRequestBuilder	cookie(Cookie... cookies) Add the given cookies to the request.
protected MockHttpServletRequest	createServletRequest(ServletContext servletContext) Create a new MockHttpServletRequest based on the given ServletContext.
MockHttpServletRequestBuilder	flashAttr(java.lang.String name, java.lang.Object value) Set an "input" flash attribute.
MockHttpServletRequestBuilder	flashAttrs(java.util.Map<java.lang.String,java.lang.Object> flashAttributes) Set flash attributes.
private FlashMapManager	getFlashMapManager(MockHttpServletRequest request)
MockHttpServletRequestBuilder	header(java.lang.String name, java.lang.Object... values) Add a header to the request.
MockHttpServletRequestBuilder	headers(HttpHeaders httpHeaders) Add all headers to the request.
boolean	isMergeEnabled() Is merging enabled for this particular instance?
MockHttpServletRequestBuilder	locale(java.util.Locale locale) Set the locale of the request.
java.lang.Object	merge(java.lang.Object parent) Merges the properties of the "parent" RequestBuilder accepting values only if not already set in "this" instance.
MockHttpServletRequestBuilder	param(java.lang.String name, java.lang.String... values) Add a request parameter to the MockHttpServletRequest.
MockHttpServletRequestBuilder	pathInfo(java.lang.String pathInfo) Specify the portion of the requestURI that represents the pathInfo.
MockHttpServletRequest	postProcessRequest(MockHttpServletRequest request) Apply request post processing.
MockHttpServletRequestBuilder	principal(java.security.Principal principal) Set the principal of the request.
MockHttpServletRequestBuilder	requestAttr(java.lang.String name, java.lang.Object value) Set a request attribute.
MockHttpServletRequestBuilder	secure(boolean secure) Set the secure property of the ServletRequest indicating use of a secure channel, such as HTTPS.
MockHttpServletRequestBuilder	servletPath(java.lang.String servletPath) Specify the portion of the requestURI that represents the path to which the Servlet is mapped.
MockHttpServletRequestBuilder	session(MockHttpSession session) Set the HTTP session to use, possibly re-used across requests.
MockHttpServletRequestBuilder	sessionAttr(java.lang.String name, java.lang.Object value) Set a session attribute.
MockHttpServletRequestBuilder	sessionAttrs(java.util.Map<java.lang.String,java.lang.Object> sessionAttributes) Set session attributes.
private void	updatePathRequestProperties(MockHttpServletRequest request, java.lang.String requestUri) Update the contextPath, servletPath, and pathInfo of the request.
MockHttpServletRequestBuilder	with(RequestPostProcessor postProcessor) An extension point for further initialization of MockHttpServletRequest in ways not built directly into the MockHttpServletRequestBuilder.

Methods inherited from class java.lang.Object

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

Field Detail

method

private final HttpMethod method

uriComponents

private final UriComponents uriComponents

headers

private final MultiValueMap<java.lang.String,java.lang.Object> headers

contentType

private java.lang.String contentType

content

private byte[] content

parameters

private final MultiValueMap<java.lang.String,java.lang.String> parameters

cookies

private final java.util.List<Cookie> cookies

locale

private java.util.Locale locale

characterEncoding

private java.lang.String characterEncoding

secure

private java.lang.Boolean secure

principal

private java.security.Principal principal

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

session

private MockHttpSession session

sessionAttributes

private final java.util.Map<java.lang.String,java.lang.Object> sessionAttributes

flashAttributes

private final java.util.Map<java.lang.String,java.lang.Object> flashAttributes

contextPath

private java.lang.String contextPath

servletPath

private java.lang.String servletPath

pathInfo

private java.lang.String pathInfo

postProcessors

private final java.util.List<RequestPostProcessor> postProcessors

Constructor Detail

MockHttpServletRequestBuilder

MockHttpServletRequestBuilder(HttpMethod httpMethod,
                              java.lang.String urlTemplate,
                              java.lang.Object... urlVariables)

Package private constructor. To get an instance, use static factory methods in MockMvcRequestBuilders.

Although this class cannot be extended, additional ways to initialize the MockHttpServletRequest can be plugged in via with(RequestPostProcessor).

Parameters:

httpMethod - the HTTP method (GET, POST, etc)

urlTemplate - a URL template; the resulting URL will be encoded

urlVariables - zero or more URL variables

MockHttpServletRequestBuilder

MockHttpServletRequestBuilder(HttpMethod httpMethod,
                              java.net.URI uri)

Package private constructor. To get an instance, use static factory methods in MockMvcRequestBuilders.

Although this class cannot be extended, additional ways to initialize the MockHttpServletRequest can be plugged in via with(RequestPostProcessor).

Parameters:

httpMethod - the HTTP method (GET, POST, etc)

uri - the URL

Since:

4.0.3

Method Detail

param

public MockHttpServletRequestBuilder param(java.lang.String name,
                                           java.lang.String... values)

Add a request parameter to the MockHttpServletRequest. If called more than once, the new values are added.

Parameters:

name - the parameter name

values - one or more values

header

public MockHttpServletRequestBuilder header(java.lang.String name,
                                            java.lang.Object... values)

Add a header to the request. Values are always added.

Parameters:

name - the header name

values - one or more header values

headers

public MockHttpServletRequestBuilder headers(HttpHeaders httpHeaders)

Add all headers to the request. Values are always added.

Parameters:

httpHeaders - the headers and values to add

contentType

public MockHttpServletRequestBuilder contentType(MediaType contentType)

Set the 'Content-Type' header of the request.

Parameters:

contentType - the content type

contentType

public MockHttpServletRequestBuilder contentType(java.lang.String contentType)

Set the 'Content-Type' header of the request.

Parameters:

contentType - the content type

Since:

4.1.2

accept

public MockHttpServletRequestBuilder accept(MediaType... mediaTypes)

Set the 'Accept' header to the given media type(s).

Parameters:

mediaTypes - one or more media types

accept

public MockHttpServletRequestBuilder accept(java.lang.String... mediaTypes)

Set the 'Accept' header to the given media type(s).

Parameters:

mediaTypes - one or more media types

content

public MockHttpServletRequestBuilder content(byte[] content)

Set the request body.

Parameters:

content - the body content

content

public MockHttpServletRequestBuilder content(java.lang.String content)

Set the request body as a UTF-8 String.

Parameters:

content - the body content

cookie

public MockHttpServletRequestBuilder cookie(Cookie... cookies)

Add the given cookies to the request. Cookies are always added.

Parameters:

cookies - the cookies to add

locale

public MockHttpServletRequestBuilder locale(java.util.Locale locale)

Set the locale of the request.

Parameters:

locale - the locale

characterEncoding

public MockHttpServletRequestBuilder characterEncoding(java.lang.String encoding)

Set the character encoding of the request.

Parameters:

encoding - the character encoding

requestAttr

public MockHttpServletRequestBuilder requestAttr(java.lang.String name,
                                                 java.lang.Object value)

Set a request attribute.

Parameters:

name - the attribute name

value - the attribute value

sessionAttr

public MockHttpServletRequestBuilder sessionAttr(java.lang.String name,
                                                 java.lang.Object value)

Set a session attribute.

Parameters:

name - the session attribute name

value - the session attribute value

sessionAttrs

public MockHttpServletRequestBuilder sessionAttrs(java.util.Map<java.lang.String,java.lang.Object> sessionAttributes)

Set session attributes.

Parameters:

sessionAttributes - the session attributes

flashAttr

public MockHttpServletRequestBuilder flashAttr(java.lang.String name,
                                               java.lang.Object value)

Set an "input" flash attribute.

Parameters:

name - the flash attribute name

value - the flash attribute value

flashAttrs

public MockHttpServletRequestBuilder flashAttrs(java.util.Map<java.lang.String,java.lang.Object> flashAttributes)

Set flash attributes.

Parameters:

flashAttributes - the flash attributes

session

public MockHttpServletRequestBuilder session(MockHttpSession session)

Set the HTTP session to use, possibly re-used across requests.

Individual attributes provided via sessionAttr(String, Object) override the content of the session provided here.

Parameters:

session - the HTTP session

principal

public MockHttpServletRequestBuilder principal(java.security.Principal principal)

Set the principal of the request.

Parameters:

principal - the principal

contextPath

public MockHttpServletRequestBuilder contextPath(java.lang.String contextPath)

Specify the portion of the requestURI that represents the context path. The context path, if specified, must match to the start of the request URI.

In most cases, tests can be written by omitting the context path from the requestURI. This is because most applications don't actually depend on the name under which they're deployed. If specified here, the context path must start with a "/" and must not end with a "/".

See Also:

HttpServletRequest.getContextPath()

servletPath

public MockHttpServletRequestBuilder servletPath(java.lang.String servletPath)

Specify the portion of the requestURI that represents the path to which the Servlet is mapped. This is typically a portion of the requestURI after the context path.

In most cases, tests can be written by omitting the servlet path from the requestURI. This is because most applications don't actually depend on the prefix to which a servlet is mapped. For example if a Servlet is mapped to "/main/*", tests can be written with the requestURI "/accounts/1" as opposed to "/main/accounts/1". If specified here, the servletPath must start with a "/" and must not end with a "/".

See Also:

HttpServletRequest.getServletPath()

pathInfo

public MockHttpServletRequestBuilder pathInfo(java.lang.String pathInfo)

Specify the portion of the requestURI that represents the pathInfo.

If left unspecified (recommended), the pathInfo will be automatically derived by removing the contextPath and the servletPath from the requestURI and using any remaining part. If specified here, the pathInfo must start with a "/".

If specified, the pathInfo will be used as is.

See Also:

HttpServletRequest.getServletPath()

secure

public MockHttpServletRequestBuilder secure(boolean secure)

Set the secure property of the ServletRequest indicating use of a secure channel, such as HTTPS.

Parameters:

secure - whether the request is using a secure channel

with

public MockHttpServletRequestBuilder with(RequestPostProcessor postProcessor)

An extension point for further initialization of MockHttpServletRequest in ways not built directly into the MockHttpServletRequestBuilder. Implementation of this interface can have builder-style methods themselves and be made accessible through static factory methods.

Specified by:

with in interface ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

postProcessor - a post-processor to add

isMergeEnabled

public boolean isMergeEnabled()

Is merging enabled for this particular instance?

Specified by:

isMergeEnabled in interface Mergeable

Returns:

always returns true.

merge

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

Merges the properties of the "parent" RequestBuilder accepting values only if not already set in "this" instance.

Specified by:

merge in interface Mergeable

Parameters:

parent - the parent RequestBuilder to inherit properties from

Returns:

the result of the merge

containsCookie

private boolean containsCookie(Cookie cookie)

buildRequest

public final MockHttpServletRequest buildRequest(ServletContext servletContext)

Build a MockHttpServletRequest.

Specified by:

buildRequest in interface RequestBuilder

Parameters:

servletContext - the ServletContext to use to create the request

Returns:

the request

createServletRequest

protected MockHttpServletRequest createServletRequest(ServletContext servletContext)

Create a new MockHttpServletRequest based on the given ServletContext. Can be overridden in subclasses.

updatePathRequestProperties

private void updatePathRequestProperties(MockHttpServletRequest request,
                                         java.lang.String requestUri)

Update the contextPath, servletPath, and pathInfo of the request.

getFlashMapManager

private FlashMapManager getFlashMapManager(MockHttpServletRequest request)

postProcessRequest

public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request)

Description copied from interface: SmartRequestBuilder

Apply request post processing. Typically that means invoking one or more RequestPostProcessors.

Specified by:

postProcessRequest in interface SmartRequestBuilder

Parameters:

request - the request to initialize

Returns:

the request to use, either the one passed in or a wrapped one

addToMultiValueMap

private static <T> void addToMultiValueMap(MultiValueMap<java.lang.String,T> map,
                                           java.lang.String name,
                                           T[] values)

addAttributeToMap

private static void addAttributeToMap(java.util.Map<java.lang.String,java.lang.Object> map,
                                      java.lang.String name,
                                      java.lang.Object value)