Class AbstractMockHttpservletRequestBuilder<B extends AbstractMockHttpservletRequestBuilder<B>>

java.lang.Object

org.springframework.test.web.servlet.request.AbstractMockHttpservletRequestBuilder<B>

Type Parameters:

B - a self reference to the builder type

All Implemented Interfaces:

Mergeable, ConfigurablesmartRequestBuilder<B>, RequestBuilder, smartRequestBuilder

Direct Known subclasses:

AbstractMockMultipartHttpservletRequestBuilder, MockHttpservletRequestBuilder, MockMvcTester.MockMvcRequestBuilder

public abstract class AbstractMockHttpservletRequestBuilder<B extends AbstractMockHttpservletRequestBuilder<B>>
extends Object
implements ConfigurablesmartRequestBuilder<B>, Mergeable

Base builder for MockHttpservletRequest required as input to perform requests in MockMvc.

since:

6.2

Author:

Rossen stoyanchev, Juergen Hoeller, Arjen Poutsma, sam Brannen, Kamill sokol

Constructor summary

Constructors

Modifier	Constructor	Description
protected	AbstractMockHttpservletRequestBuilder(HttpMethod httpMethod)	Create a new instance using the specified HttpMethod.

Method summary

Modifier and Type	Method	Description
B	accept(string... mediaTypes)	set the Accept header using raw string values, possibly not even well-formed (for testing purposes).
B	accept(MediaType... mediaTypes)	set the 'Accept' header to the given media type(s).
B	acceptCharset(Charset... acceptableCharsets)	set the list of acceptable charsets, as specified by the Accept-Charset header.
B	apiVersion(Object version)	set an API version for the request.
B	apiVersionInserter(@Nullable ApiVersionInserter versionInserter)	Configure an ApiVersionInserter to abstract how an API version specified via apiVersion(Object) is inserted into the request.
final MockHttpservletRequest	buildRequest(jakarta.servlet.servletContext servletContext)	Build a MockHttpservletRequest.
B	characterEncoding(string encoding)	set the character encoding of the request.
B	characterEncoding(Charset encoding)	set the character encoding of the request.
B	content(byte[] content)	set the request body.
B	content(string content)	set the request body as a UTF-8 string.
B	contentType(string contentType)	set the 'Content-Type' header of the request as a raw string value, possibly not even well-formed (for testing purposes).
B	contentType(MediaType contentType)	set the 'Content-Type' header of the request.
B	contextPath(string contextPath)	specify the portion of the requestURI that represents the context path.
B	cookie(jakarta.servlet.http.Cookie... cookies)	Add the given cookies to the request.
protected MockHttpservletRequest	createservletRequest(jakarta.servlet.servletContext servletContext)	Create a new MockHttpservletRequest based on the supplied servletContext.
B	flashAttr(string name, Object value)	set an "input" flash attribute.
B	flashAttrs(Map<string,Object>&nbsp;flashAttributes)	set flash attributes.
B	formField(string&nbsp;name, string...&nbsp;values)	Append the given value(s) to the given form field and also add them to the request parameters map.
B	formFields(MultiValueMap<string,string>&nbsp;formFields)	Variant of formField(string, string...) with a MultiValueMap.
B	header(string&nbsp;name, Object...&nbsp;values)	Add a header to the request.
B	headers(Consumer<HttpHeaders>&nbsp;headersConsumer)	Provides access to every header declared so far with the possibility to add, replace, or remove values.
B	headers(HttpHeaders&nbsp;httpHeaders)	Add all headers to the request.
B	ifModifiedsince(ZonedDateTime&nbsp;ifModifiedsince)	set the value of the If-Modified-since header.
B	ifNoneMatch(string...&nbsp;ifNoneMatches)	set the values of the If-None-Match header.
boolean	isMergeEnabled()	Is merging enabled for this particular instance?
B	locale(@Nullable Locale&nbsp;locale)	set the locale of the request, overriding any previous locales.
B	locale(Locale...&nbsp;locales)	Add the specified locales as preferred request locales.
Object	merge(@Nullable Object&nbsp;parent)	Merges the properties of the "parent" RequestBuilder accepting values only if not already set in "this" instance.
B	param(string&nbsp;name, string...&nbsp;values)	Add a request parameter to MockHttpservletRequest.getParameterMap().
B	params(MultiValueMap<string,string>&nbsp;params)	Variant of param(string, string...) with a MultiValueMap.
B	pathInfo(@Nullable string&nbsp;pathInfo)	specify the portion of the requestURI that represents the pathInfo.
MockHttpservletRequest	postProcessRequest(MockHttpservletRequest&nbsp;request)	Apply request post-processing.
B	principal(Principal&nbsp;principal)	set the principal of the request.
B	queryParam(string&nbsp;name, string...&nbsp;values)	Append to the query string and also add to the request parameters map.
B	queryParams(MultiValueMap<string,string>&nbsp;params)	Append to the query string and also add to the request parameters map.
B	remoteAddress(string&nbsp;remoteAddress)	set the remote address of the request.
B	requestAttr(string&nbsp;name, Object&nbsp;value)	set a request attribute.
B	secure(boolean&nbsp;secure)	set the secure property of the servletRequest indicating use of a secure channel, such as HTTPs.
protected B	self()	&nbsp;
B	servletPath(string&nbsp;servletPath)	specify the portion of the requestURI that represents the path to which the servlet is mapped.
B	session(MockHttpsession&nbsp;session)	set the HTTP session to use, possibly re-used across requests.
B	sessionAttr(string&nbsp;name, Object&nbsp;value)	set a session attribute.
B	sessionAttrs(Map<string,Object>&nbsp;sessionAttributes)	set session attributes.
B	uri(string&nbsp;uriTemplate, @Nullable Object...&nbsp;uriVariables)	specify the URI for the request using a URI template and URI variables.
B	uri(URI&nbsp;uri)	specify the URI using an absolute, fully constructed URI.
B	with(RequestPostProcessor&nbsp;postProcessor)	An extension point for further initialization of MockHttpservletRequest in ways not built directly into the MockHttpservletRequestBuilder.

Methods inherited from class&nbsp;Object

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

Constructor Details

AbstractMockHttpservletRequestBuilder

protected AbstractMockHttpservletRequestBuilder(HttpMethod httpMethod)

Create a new instance using the specified HttpMethod.

Parameters:

httpMethod - the HTTP method (GET, POsT, etc.)

Method Details

self

protected B self()

uri

public B uri(URI uri)

specify the URI using an absolute, fully constructed URI.

uri

public B uri(string uriTemplate,
 @Nullable Object... uriVariables)

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

contextPath

public B contextPath(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 B servletPath(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 B pathInfo(@Nullable 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.getPathInfo()

secure

public B 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

characterEncoding

public B characterEncoding(Charset encoding)

set the character encoding of the request.

Parameters:

encoding - the character encoding

since:

5.3.10

see Also:

• standardCharsets
• characterEncoding(string)

characterEncoding

public B characterEncoding(string encoding)

set the character encoding of the request.

Parameters:

encoding - the character encoding

content

public B content(byte[] content)

set the request body.

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

Parameters:

content - the body content

content

public B content(string content)

set the request body as a UTF-8 string.

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

Parameters:

content - the body content

contentType

public B contentType(MediaType contentType)

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.

Parameters:

contentType - the content type

contentType

public B contentType(string contentType)

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

Parameters:

contentType - the content type

since:

4.1.2

accept

public B accept(MediaType... mediaTypes)

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

Parameters:

mediaTypes - one or more media types

accept

public B accept(string... mediaTypes)

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

Parameters:

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

acceptCharset

public B acceptCharset(Charset... acceptableCharsets)

set the list of acceptable charsets, as specified by the Accept-Charset header.

Parameters:

acceptableCharsets - the acceptable charsets

since:

7.0

ifModifiedsince

public B ifModifiedsince(ZonedDateTime ifModifiedsince)

set the value of the If-Modified-since header.

Parameters:

ifModifiedsince - the new value of the header

since:

7.0

ifNoneMatch

public B ifNoneMatch(string... ifNoneMatches)

set the values of the If-None-Match header.

Parameters:

ifNoneMatches - the new value of the header

since:

7.0

header

public B header(string name,
 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 B headers(HttpHeaders httpHeaders)

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

Parameters:

httpHeaders - the headers and values to add

headers

public&nbsp;B&nbsp;headers(Consumer<HttpHeaders>&nbsp;headersConsumer)

Provides access to every header declared so far with the possibility to add, replace, or remove values.

Parameters:

headersConsumer - the consumer to provide access to

Returns:

this builder

since:

7.0

param

public B param(string name,
 string... values)

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 queryParam(string, string...) or queryParams.
• Provide content with contentType application/x-www-form-urlencoded.

Parameters:

name - the parameter name

values - one or more values

params

public&nbsp;B&nbsp;params(MultiValueMap<string,string>&nbsp;params)

Variant of param(string, string...) with a MultiValueMap.

Parameters:

params - the parameters to add

since:

4.2.4

queryParam

public B queryParam(string name,
 string... values)

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.

Parameters:

name - the parameter name

values - one or more values

since:

5.2.2

queryParams

public&nbsp;B&nbsp;queryParams(MultiValueMap<string,string>&nbsp;params)

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.

Parameters:

params - the parameters to add

since:

5.2.2

formField

public B formField(string name,
 string... values)

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

Parameters:

name - the field name

values - one or more values

since:

6.1.7

formFields

public&nbsp;B&nbsp;formFields(MultiValueMap<string,string>&nbsp;formFields)

Variant of formField(string, string...) with a MultiValueMap.

Parameters:

formFields - the form fields to add

since:

6.1.7

cookie

public B cookie(jakarta.servlet.http.Cookie... cookies)

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

Parameters:

cookies - the cookies to add

locale

public B locale(Locale... locales)

Add the specified locales as preferred request locales.

Parameters:

locales - the locales to add

since:

4.3.6

see Also:

• locale(Locale)

locale

public B locale(@Nullable Locale locale)

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

Parameters:

locale - the locale, or null to reset it

see Also:

• locale(Locale...)

apiVersion

public B apiVersion(Object version)

set an API version for the request. The version is inserted into the request by the configured ApiVersionInserter.

Parameters:

version - the API version of the request; this can be a string or some Object that can be formatted the inserter, e.g. through an ApiVersionFormatter.

since:

7.0

apiVersionInserter

public B apiVersionInserter(@Nullable ApiVersionInserter versionInserter)

Configure an ApiVersionInserter to abstract how an API version specified via apiVersion(Object) is inserted into the request. An inserter may typically be set once (more centrally) via ConfigurableMockMvcBuilder.defaultRequest(RequestBuilder), or ConfigurableMockMvcBuilder.apiVersionInserter(ApiVersionInserter).

ApiVersionInserter exposes shortcut methods for several built-in inserter implementation types. see the class-level Javadoc of ApiVersionInserter for a list of choices.

Parameters:

versionInserter - the inserter to use

since:

7.0

requestAttr

public B requestAttr(string name,
 Object value)

set a request attribute.

Parameters:

name - the attribute name

value - the attribute value

sessionAttr

public B sessionAttr(string name,
 Object value)

set a session attribute.

Parameters:

name - the session attribute name

value - the session attribute value

sessionAttrs

public&nbsp;B&nbsp;sessionAttrs(Map<string,Object>&nbsp;sessionAttributes)

set session attributes.

Parameters:

sessionAttributes - the session attributes

flashAttr

public B flashAttr(string name,
 Object value)

set an "input" flash attribute.

Parameters:

name - the flash attribute name

value - the flash attribute value

flashAttrs

public&nbsp;B&nbsp;flashAttrs(Map<string,Object>&nbsp;flashAttributes)

set flash attributes.

Parameters:

flashAttributes - the flash attributes

session

public B 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 B principal(Principal principal)

set the principal of the request.

Parameters:

principal - the principal

remoteAddress

public B remoteAddress(string remoteAddress)

set the remote address of the request.

Parameters:

remoteAddress - the remote address (IP)

since:

6.0.10

with

public B 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&nbsp;in interface&nbsp;ConfigurablesmartRequestBuilder<B extends AbstractMockHttpservletRequestBuilder<B>>

Parameters:

postProcessor - a post-processor to add

isMergeEnabled

public boolean isMergeEnabled()

Is merging enabled for this particular instance?

specified by:

isMergeEnabled&nbsp;in interface&nbsp;Mergeable

Returns:

always returns true.

merge

public Object merge(@Nullable Object parent)

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

specified by:

merge&nbsp;in interface&nbsp;Mergeable

Parameters:

parent - the parent RequestBuilder to inherit properties from

Returns:

the result of the merge

buildRequest

public final MockHttpservletRequest buildRequest(jakarta.servlet.servletContext servletContext)

Build a MockHttpservletRequest.

specified by:

buildRequest&nbsp;in interface&nbsp;RequestBuilder

Parameters:

servletContext - the servletContext to use to create the request

Returns:

the request

createservletRequest

protected MockHttpservletRequest createservletRequest(jakarta.servlet.servletContext servletContext)

Create a new MockHttpservletRequest based on the supplied servletContext.

Can be overridden in subclasses.

postProcessRequest

public MockHttpservletRequest postProcessRequest(MockHttpservletRequest request)

Description copied from interface:&nbsp;smartRequestBuilder

Apply request post-processing. Typically, that means invoking one or more org.springframework.test.web.servlet.request.RequestPostProcessors.

specified by:

postProcessRequest&nbsp;in interface&nbsp;smartRequestBuilder

Parameters:

request - the request to initialize

Returns:

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