Package org.springframework.test.web.servlet.request

Class MockHttpServletRequestBuilder

java.lang.Object

org.springframework.test.web.servlet.request.AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

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

All Implemented Interfaces:

Mergeable, ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>, RequestBuilder, SmartRequestBuilder

Direct Known Subclasses:

MockMultipartHttpServletRequestBuilder

public class MockHttpServletRequestBuilder
extends AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

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.

This class is not open for extension. To apply custom initialization to the created MockHttpServletRequest, please use the with(RequestPostProcessor) extension point.

Since:

3.2

Author:

Rossen Stoyanchev, Juergen Hoeller, Arjen Poutsma, Sam Brannen, Kamill Sokol

Method Summary

Modifier and Type	Method	Description
MockHttpServletRequestBuilder	accept(String... mediaTypes)	Set the Accept header using raw String values, possibly not even well-formed (for testing purposes).
MockHttpServletRequestBuilder	accept(MediaType... mediaTypes)	Set the 'Accept' header to the given media type(s).
MockHttpServletRequestBuilder	characterEncoding(String encoding)	Set the character encoding of the request.
MockHttpServletRequestBuilder	characterEncoding(Charset encoding)	Set the character encoding of the request.
MockHttpServletRequestBuilder	content(byte[] content)	Set the request body.
MockHttpServletRequestBuilder	content(String content)	Set the request body as a UTF-8 String.
MockHttpServletRequestBuilder	contentType(String contentType)	Set the 'Content-Type' header of the request as a raw String value, possibly not even well-formed (for testing purposes).
MockHttpServletRequestBuilder	contentType(MediaType contentType)	Set the 'Content-Type' header of the request.
MockHttpServletRequestBuilder	contextPath(String contextPath)	Specify the portion of the requestURI that represents the context path.
MockHttpServletRequestBuilder	cookie(Cookie... cookies)	Add the given cookies to the request.
MockHttpServletRequestBuilder	flashAttr(String name, Object value)	Set an "input" flash attribute.
MockHttpServletRequestBuilder	flashAttrs(Map<String,Object> flashAttributes)	Set flash attributes.
MockHttpServletRequestBuilder	formField(String name, String... values)	Append the given value(s) to the given form field and also add them to the request parameters map.
MockHttpServletRequestBuilder	formFields(MultiValueMap<String,String> formFields)	Variant of AbstractMockHttpServletRequestBuilder.formField(String, String...) with a MultiValueMap.
MockHttpServletRequestBuilder	header(String name, Object... values)	Add a header to the request.
MockHttpServletRequestBuilder	headers(HttpHeaders httpHeaders)	Add all headers to the request.
MockHttpServletRequestBuilder	locale(Locale locale)	Set the locale of the request, overriding any previous locales.
MockHttpServletRequestBuilder	locale(Locale... locales)	Add the specified locales as preferred request locales.
MockHttpServletRequestBuilder	param(String name, String... values)	Add a request parameter to MockHttpServletRequest.getParameterMap().
MockHttpServletRequestBuilder	params(MultiValueMap<String,String> params)	Variant of AbstractMockHttpServletRequestBuilder.param(String, String...) with a MultiValueMap.
MockHttpServletRequestBuilder	pathInfo(String pathInfo)	Specify the portion of the requestURI that represents the pathInfo.
MockHttpServletRequestBuilder	principal(Principal principal)	Set the principal of the request.
MockHttpServletRequestBuilder	queryParam(String name, String... values)	Append to the query string and also add to the request parameters map.
MockHttpServletRequestBuilder	queryParams(MultiValueMap<String,String> params)	Append to the query string and also add to the request parameters map.
MockHttpServletRequestBuilder	remoteAddress(String remoteAddress)	Set the remote address of the request.
MockHttpServletRequestBuilder	requestAttr(String name, 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(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(String name, Object value)	Set a session attribute.
MockHttpServletRequestBuilder	sessionAttrs(Map<String,Object> sessionAttributes)	Set session attributes.
MockHttpServletRequestBuilder	uri(String uriTemplate, Object... uriVariables)	Specify the URI for the request using a URI template and URI variables.
MockHttpServletRequestBuilder	uri(URI uri)	Specify the URI using an absolute, fully constructed URI.
MockHttpServletRequestBuilder	with(RequestPostProcessor postProcessor)	An extension point for further initialization of MockHttpServletRequest in ways not built directly into the MockHttpServletRequestBuilder.

Methods inherited from class org.springframework.test.web.servlet.request.AbstractMockHttpServletRequestBuilder

buildRequest, createServletRequest, isMergeEnabled, merge, postProcessRequest, self

Methods inherited from class java.lang.Object

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

Method Details

uri

public MockHttpServletRequestBuilder uri(URI uri)

Description copied from class: AbstractMockHttpServletRequestBuilder

Specify the URI using an absolute, fully constructed URI.

Overrides:

uri in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

uri

public MockHttpServletRequestBuilder uri(String uriTemplate,
 Object... uriVariables)

Description copied from class: AbstractMockHttpServletRequestBuilder

Specify the URI for the request using a URI template and URI variables.

Overrides:

uri in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

contextPath

public MockHttpServletRequestBuilder contextPath(String contextPath)

Description copied from class: AbstractMockHttpServletRequestBuilder

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 "/".

Overrides:

contextPath in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

See Also:

• HttpServletRequest.getContextPath()

servletPath

public MockHttpServletRequestBuilder servletPath(String servletPath)

Description copied from class: AbstractMockHttpServletRequestBuilder

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 "/".

Overrides:

servletPath in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

See Also:

• HttpServletRequest.getServletPath()

pathInfo

public MockHttpServletRequestBuilder pathInfo(@Nullable
 String pathInfo)

Description copied from class: AbstractMockHttpServletRequestBuilder

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.

Overrides:

pathInfo in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

See Also:

• HttpServletRequest.getPathInfo()

secure

public MockHttpServletRequestBuilder secure(boolean secure)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

Overrides:

secure in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

secure - whether the request is using a secure channel

characterEncoding

public MockHttpServletRequestBuilder characterEncoding(Charset encoding)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the character encoding of the request.

Overrides:

characterEncoding in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

encoding - the character encoding

See Also:

• StandardCharsets
• AbstractMockHttpServletRequestBuilder.characterEncoding(String)

characterEncoding

public MockHttpServletRequestBuilder characterEncoding(String encoding)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the character encoding of the request.

Overrides:

characterEncoding in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

encoding - the character encoding

content

public MockHttpServletRequestBuilder content(byte[] content)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the request body.

If content is provided and AbstractMockHttpServletRequestBuilder.contentType(MediaType) is set to application/x-www-form-urlencoded, the content will be parsed and used to populate the request parameters map.

Overrides:

content in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

content - the body content

content

public MockHttpServletRequestBuilder content(String content)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the request body as a UTF-8 String.

If content is provided and AbstractMockHttpServletRequestBuilder.contentType(MediaType) is set to application/x-www-form-urlencoded, the content will be parsed and used to populate the request parameters map.

Overrides:

content in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

content - the body content

contentType

public MockHttpServletRequestBuilder contentType(MediaType contentType)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

If content is provided and contentType is set to application/x-www-form-urlencoded, the content will be parsed and used to populate the request parameters map.

Overrides:

contentType in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

contentType - the content type

contentType

public MockHttpServletRequestBuilder contentType(String contentType)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the 'Content-Type' header of the request as a raw String value, possibly not even well-formed (for testing purposes).

Overrides:

contentType in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

contentType - the content type

accept

public MockHttpServletRequestBuilder accept(MediaType... mediaTypes)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

Overrides:

accept in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

mediaTypes - one or more media types

accept

public MockHttpServletRequestBuilder accept(String... mediaTypes)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the Accept header using raw String values, possibly not even well-formed (for testing purposes).

Overrides:

accept in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

mediaTypes - one or more media types; internally joined as comma-separated String

header

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

Description copied from class: AbstractMockHttpServletRequestBuilder

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

Overrides:

header in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the header name

values - one or more header values

headers

public MockHttpServletRequestBuilder headers(HttpHeaders httpHeaders)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

Overrides:

headers in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

httpHeaders - the headers and values to add

param

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

Description copied from class: AbstractMockHttpServletRequestBuilder

Add a request parameter to MockHttpServletRequest.getParameterMap().

In the Servlet API, a request parameter may be parsed from the query string and/or from the body of an application/x-www-form-urlencoded request. This method simply adds to the request parameter map. You may also use add Servlet request parameters by specifying the query or form data through one of the following:

• Supply a URL with a query to MockMvcRequestBuilders.
• Add query params via AbstractMockHttpServletRequestBuilder.queryParam(java.lang.String, java.lang.String...) or AbstractMockHttpServletRequestBuilder.queryParams.
• Provide AbstractMockHttpServletRequestBuilder.content with AbstractMockHttpServletRequestBuilder.contentType application/x-www-form-urlencoded.

Overrides:

param in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the parameter name

values - one or more values

params

public MockHttpServletRequestBuilder params(MultiValueMap<String,String> params)

Description copied from class: AbstractMockHttpServletRequestBuilder

Variant of AbstractMockHttpServletRequestBuilder.param(String, String...) with a MultiValueMap.

Overrides:

params in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

params - the parameters to add

queryParam

public MockHttpServletRequestBuilder queryParam(String name,
 String... values)

Description copied from class: AbstractMockHttpServletRequestBuilder

Append to the query string and also add to the request parameters map. The parameter name and value are encoded when they are added to the query string.

Overrides:

queryParam in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the parameter name

values - one or more values

queryParams

public MockHttpServletRequestBuilder queryParams(MultiValueMap<String,String> params)

Description copied from class: AbstractMockHttpServletRequestBuilder

Append to the query string and also add to the request parameters map. The parameter name and value are encoded when they are added to the query string.

Overrides:

queryParams in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

params - the parameters to add

formField

public MockHttpServletRequestBuilder formField(String name,
 String... values)

Description copied from class: AbstractMockHttpServletRequestBuilder

Append the given value(s) to the given form field and also add them to the request parameters map.

Overrides:

formField in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the field name

values - one or more values

formFields

public MockHttpServletRequestBuilder formFields(MultiValueMap<String,String> formFields)

Description copied from class: AbstractMockHttpServletRequestBuilder

Variant of AbstractMockHttpServletRequestBuilder.formField(String, String...) with a MultiValueMap.

Overrides:

formFields in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

formFields - the form fields to add

cookie

public MockHttpServletRequestBuilder cookie(Cookie... cookies)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

Overrides:

cookie in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

cookies - the cookies to add

locale

public MockHttpServletRequestBuilder locale(Locale... locales)

Description copied from class: AbstractMockHttpServletRequestBuilder

Add the specified locales as preferred request locales.

Overrides:

locale in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

locales - the locales to add

See Also:

• AbstractMockHttpServletRequestBuilder.locale(Locale)

locale

public MockHttpServletRequestBuilder locale(@Nullable
 Locale locale)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the locale of the request, overriding any previous locales.

Overrides:

locale in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

locale - the locale, or null to reset it

See Also:

• AbstractMockHttpServletRequestBuilder.locale(Locale...)

requestAttr

public MockHttpServletRequestBuilder requestAttr(String name,
 Object value)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set a request attribute.

Overrides:

requestAttr in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the attribute name

value - the attribute value

sessionAttr

public MockHttpServletRequestBuilder sessionAttr(String name,
 Object value)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set a session attribute.

Overrides:

sessionAttr in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the session attribute name

value - the session attribute value

sessionAttrs

public MockHttpServletRequestBuilder sessionAttrs(Map<String,Object> sessionAttributes)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set session attributes.

Overrides:

sessionAttrs in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

sessionAttributes - the session attributes

flashAttr

public MockHttpServletRequestBuilder flashAttr(String name,
 Object value)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set an "input" flash attribute.

Overrides:

flashAttr in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

name - the flash attribute name

value - the flash attribute value

flashAttrs

public MockHttpServletRequestBuilder flashAttrs(Map<String,Object> flashAttributes)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set flash attributes.

Overrides:

flashAttrs in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

flashAttributes - the flash attributes

session

public MockHttpServletRequestBuilder session(MockHttpSession session)

Description copied from class: AbstractMockHttpServletRequestBuilder

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

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

Overrides:

session in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

session - the HTTP session

principal

public MockHttpServletRequestBuilder principal(Principal principal)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the principal of the request.

Overrides:

principal in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

principal - the principal

remoteAddress

public MockHttpServletRequestBuilder remoteAddress(String remoteAddress)

Description copied from class: AbstractMockHttpServletRequestBuilder

Set the remote address of the request.

Overrides:

remoteAddress in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

remoteAddress - the remote address (IP)

with

public MockHttpServletRequestBuilder with(RequestPostProcessor postProcessor)

Description copied from class: AbstractMockHttpServletRequestBuilder

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>

Overrides:

with in class AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>

Parameters:

postProcessor - a post-processor to add