org.springframework.test.web.servlet.request

Class MockMultipartHttpServletRequestBuilder

java.lang.Object

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

org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder

All Implemented Interfaces:

Mergeable, ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>, RequestBuilder, SmartRequestBuilder

public class MockMultipartHttpServletRequestBuilder
extends MockHttpServletRequestBuilder

Default builder for MockMultipartHttpServletRequest.

Since:

3.2

Author:

Rossen Stoyanchev, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MockMultipartFile>	files
private MultiValueMap<java.lang.String,Part>	parts

Constructor Summary

Constructors

Constructor and Description
MockMultipartHttpServletRequestBuilder(java.lang.String urlTemplate, java.lang.Object... uriVariables) Package-private constructor.
MockMultipartHttpServletRequestBuilder(java.net.URI uri) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
protected MockHttpServletRequest	createServletRequest(ServletContext servletContext) Create a new MockMultipartHttpServletRequest based on the supplied ServletContext and the MockMultipartFiles added to this builder.
MockMultipartHttpServletRequestBuilder	file(MockMultipartFile file) Add the given MockMultipartFile.
MockMultipartHttpServletRequestBuilder	file(java.lang.String name, byte[] content) Create a new MockMultipartFile with the given content.
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.
MockMultipartHttpServletRequestBuilder	part(Part... parts) Add Part components to the request.

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

accept, accept, buildRequest, characterEncoding, content, content, contentType, contentType, contextPath, cookie, flashAttr, flashAttrs, header, headers, isMergeEnabled, locale, locale, param, params, pathInfo, postProcessRequest, principal, requestAttr, secure, servletPath, session, sessionAttr, sessionAttrs, with

Methods inherited from class java.lang.Object

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

Field Detail

files

private final java.util.List<MockMultipartFile> files

parts

private final MultiValueMap<java.lang.String,Part> parts

Constructor Detail

MockMultipartHttpServletRequestBuilder

MockMultipartHttpServletRequestBuilder(java.lang.String urlTemplate,
                                       java.lang.Object... uriVariables)

Package-private constructor. Use static factory methods in MockMvcRequestBuilders.

For other ways to initialize a MockMultipartHttpServletRequest, see MockHttpServletRequestBuilder.with(RequestPostProcessor) and the RequestPostProcessor extension point.

Parameters:

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

uriVariables - zero or more URI variables

MockMultipartHttpServletRequestBuilder

MockMultipartHttpServletRequestBuilder(java.net.URI uri)

Package-private constructor. Use static factory methods in MockMvcRequestBuilders.

For other ways to initialize a MockMultipartHttpServletRequest, see MockHttpServletRequestBuilder.with(RequestPostProcessor) and the RequestPostProcessor extension point.

Parameters:

uri - the URL

Since:

4.0.3

Method Detail

file

public MockMultipartHttpServletRequestBuilder file(java.lang.String name,
                                                   byte[] content)

Create a new MockMultipartFile with the given content.

Parameters:

name - the name of the file

content - the content of the file

file

public MockMultipartHttpServletRequestBuilder file(MockMultipartFile file)

Add the given MockMultipartFile.

Parameters:

file - the multipart file

part

public MockMultipartHttpServletRequestBuilder part(Part... parts)

Add Part components to the request.

Parameters:

parts - one or more parts to add

Since:

5.0

merge

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

Description copied from class: MockHttpServletRequestBuilder

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

Specified by:

merge in interface Mergeable

Overrides:

merge in class MockHttpServletRequestBuilder

Parameters:

parent - the parent RequestBuilder to inherit properties from

Returns:

the result of the merge

createServletRequest

protected final MockHttpServletRequest createServletRequest(ServletContext servletContext)

Create a new MockMultipartHttpServletRequest based on the supplied ServletContext and the MockMultipartFiles added to this builder.

Overrides:

createServletRequest in class MockHttpServletRequestBuilder