MockHttpServletRequestBuilder (Spring Framework 5.2.25.RELEASE API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MockHttpServletRequestBuilder`	`accept(MediaType... mediaTypes)` Set the 'Accept' header to the given media type(s).
`MockHttpServletRequestBuilder`	`accept(String... mediaTypes)` Set the 'Accept' header using raw String values, possibly not even well formed (for testing purposes).
`MockHttpServletRequest`	`buildRequest(ServletContext servletContext)` Build a `MockHttpServletRequest`.
`MockHttpServletRequestBuilder`	`characterEncoding(String 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(MediaType contentType)` Set the 'Content-Type' header of the request.
`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`	`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.
`protected MockHttpServletRequest`	`createServletRequest(ServletContext servletContext)` Create a new `MockHttpServletRequest` based on the supplied `ServletContext`.
`MockHttpServletRequestBuilder`	`flashAttr(String name, Object value)` Set an "input" flash attribute.
`MockHttpServletRequestBuilder`	`flashAttrs(Map<String,Object> flashAttributes)` Set flash attributes.
`MockHttpServletRequestBuilder`	`header(String name, 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(Locale... locales)` Add the specified locales as preferred request locales.
`MockHttpServletRequestBuilder`	`locale(Locale locale)` Set the locale of the request, overriding any previous locales.
`Object`	`merge(Object parent)` Merges the properties of the "parent" RequestBuilder accepting values only if not already set in "this" instance.
`MockHttpServletRequestBuilder`	`param(String name, String... values)` Add a request parameter to `MockHttpServletRequest.getParameterMap()`.
`MockHttpServletRequestBuilder`	`params(MultiValueMap<String,String> params)` Variant of `param(String, String...)` with a `MultiValueMap`.
`MockHttpServletRequestBuilder`	`pathInfo(String pathInfo)` Specify the portion of the requestURI that represents the pathInfo.
`MockHttpServletRequest`	`postProcessRequest(MockHttpServletRequest request)` Apply request post processing.
`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 `params(MultiValueMap)` request parameters} map.
`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`	`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

- Method Detail
  - contextPath
```
public MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder 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 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
  - characterEncoding
```
public MockHttpServletRequestBuilder characterEncoding(String encoding)
```
    Set the character encoding of the request.
    
    Parameters:
    
    encoding - the character encoding
  - content
```
public MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder 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 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).
    
    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(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
  - header
```
public MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder headers(HttpHeaders httpHeaders)
```
    Add all headers to the request. Values are always added.
    
    Parameters:
    
    httpHeaders - the headers and values to add
  - param
```
public MockHttpServletRequestBuilder 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(java.lang.String, java.lang.String...) or queryParams.
    - Provide content with contentType application/x-www-form-urlencoded.
    Parameters:
    
    name - the parameter name
    
    values - one or more values
  - params
```
public MockHttpServletRequestBuilder params(MultiValueMap<String,String> params)
```
    Variant of param(String, String...) with a MultiValueMap.
    
    Parameters:
    
    params - the parameters to add
    
    Since:
    
    4.2.4
  - queryParam
```
public MockHttpServletRequestBuilder 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 MockHttpServletRequestBuilder queryParams(MultiValueMap<String,String> params)
```
    Append to the query string and also add to the params(MultiValueMap) 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
  - 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(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 MockHttpServletRequestBuilder 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...)
  - requestAttr
```
public MockHttpServletRequestBuilder requestAttr(String name,
                                                 Object value)
```
    Set a request attribute.
    
    Parameters:
    
    name - the attribute name
    
    value - the attribute value
  - sessionAttr
```
public MockHttpServletRequestBuilder sessionAttr(String name,
                                                 Object value)
```
    Set a session attribute.
    
    Parameters:
    
    name - the session attribute name
    
    value - the session attribute value
  - sessionAttrs
```
public MockHttpServletRequestBuilder sessionAttrs(Map<String,Object> sessionAttributes)
```
    Set session attributes.
    
    Parameters:
    
    sessionAttributes - the session attributes
  - flashAttr
```
public MockHttpServletRequestBuilder flashAttr(String name,
                                               Object value)
```
    Set an "input" flash attribute.
    
    Parameters:
    
    name - the flash attribute name
    
    value - the flash attribute value
  - flashAttrs
```
public MockHttpServletRequestBuilder flashAttrs(Map<String,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(Principal principal)
```
    Set the principal of the request.
    
    Parameters:
    
    principal - the principal
  - 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 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 in interface Mergeable
    
    Parameters:
    
    parent - the parent RequestBuilder to inherit properties from
    
    Returns:
    
    the result of the merge
  - 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 supplied ServletContext.
    Can be overridden in subclasses.
  - postProcessRequest
```
public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request)
```
    Description copied from interface: SmartRequestBuilder
    
    Apply request post processing. Typically that means invoking one or more org.springframework.test.web.servlet.request.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

Class MockHttpServletRequestBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

contextPath

servletPath

pathInfo

secure

characterEncoding

content

content

contentType

contentType

accept

accept

header

headers

param

params

queryParam

queryParams

cookie

locale

locale

requestAttr

sessionAttr

sessionAttrs

flashAttr

flashAttrs

session

principal

with

isMergeEnabled

merge

buildRequest

createServletRequest

postProcessRequest