AbstractMultipartHttpServletRequest

java.lang.Object
- HttpServletRequestWrapper
- - org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest

All Implemented Interfaces:

MultipartHttpServletRequest, MultipartRequest

Direct Known Subclasses:

DefaultMultipartHttpServletRequest, StandardMultipartHttpServletRequest
```
public abstract class AbstractMultipartHttpServletRequest
extends HttpServletRequestWrapper
implements MultipartHttpServletRequest
```
Abstract base implementation of the MultipartHttpServletRequest interface. Provides management of pre-generated MultipartFile instances.

Since:

06.10.2003

Author:

Juergen Hoeller, Arjen Poutsma

Field Summary

Fields
Modifier and Type Field and Description

private MultiValueMap<java.lang.String,MultipartFile> multipartFiles

Fields
Modifier and Type	Field and Description
`private MultiValueMap<java.lang.String,MultipartFile>`	`multipartFiles`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractMultipartHttpServletRequest(HttpServletRequest request)` Wrap the given HttpServletRequest in a MultipartHttpServletRequest.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MultipartFile`	`getFile(java.lang.String name)` Return the contents plus description of an uploaded file in this request, or `null` if it does not exist.
`java.util.Map<java.lang.String,MultipartFile>`	`getFileMap()` Return a <code>Map</code> of the multipart files contained in this request.
`java.util.Iterator<java.lang.String>`	`getFileNames()` Return an <code>Iterator</code> of String objects containing the parameter names of the multipart files contained in this request.
`java.util.List<MultipartFile>`	`getFiles(java.lang.String name)` Return the contents plus description of uploaded files in this request, or an empty list if it does not exist.
`MultiValueMap<java.lang.String,MultipartFile>`	`getMultiFileMap()` Return a `MultiValueMap` of the multipart files contained in this request.
`protected MultiValueMap<java.lang.String,MultipartFile>`	`getMultipartFiles()` Obtain the MultipartFile Map for retrieval, lazily initializing it if necessary.
`HttpServletRequest`	`getRequest()`
`HttpHeaders`	`getRequestHeaders()` Return this request's headers as a convenient HttpHeaders instance.
`HttpMethod`	`getRequestMethod()` Return this request's method as a convenient HttpMethod instance.
`protected void`	`initializeMultipart()` Lazily initialize the multipart request, if possible.
`protected void`	`setMultipartFiles(MultiValueMap<java.lang.String,MultipartFile> multipartFiles)` Set a Map with parameter names as keys and list of MultipartFile objects as values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.multipart.MultipartHttpServletRequest
getMultipartHeaders

Methods inherited from interface org.springframework.web.multipart.MultipartRequest
getMultipartContentType

- Field Detail
  - multipartFiles
```
private MultiValueMap<java.lang.String,MultipartFile> multipartFiles
```
- Constructor Detail
  - AbstractMultipartHttpServletRequest
```
protected AbstractMultipartHttpServletRequest(HttpServletRequest request)
```
    Wrap the given HttpServletRequest in a MultipartHttpServletRequest.
    
    Parameters:
    
    request - the request to wrap
- Method Detail
  - getRequest
```
public HttpServletRequest getRequest()
```
  - getRequestMethod
```
public HttpMethod getRequestMethod()
```
    Description copied from interface: MultipartHttpServletRequest
    
    Return this request's method as a convenient HttpMethod instance.
    
    Specified by:
    
    getRequestMethod in interface MultipartHttpServletRequest
  - getRequestHeaders
```
public HttpHeaders getRequestHeaders()
```
    Description copied from interface: MultipartHttpServletRequest
    
    Return this request's headers as a convenient HttpHeaders instance.
    
    Specified by:
    
    getRequestHeaders in interface MultipartHttpServletRequest
  - getFileNames
```
public java.util.Iterator<java.lang.String> getFileNames()
```
    Description copied from interface: MultipartRequest
    
    Return an <code>Iterator</code> of String objects containing the parameter names of the multipart files contained in this request. These are the field names of the form (like with normal parameters), not the original file names.
    
    Specified by:
    
    getFileNames in interface MultipartRequest
    
    Returns:
    
    the names of the files
  - getFile
```
public MultipartFile getFile(java.lang.String name)
```
    Description copied from interface: MultipartRequest
    
    Return the contents plus description of an uploaded file in this request, or null if it does not exist.
    
    Specified by:
    
    getFile in interface MultipartRequest
    
    Parameters:
    
    name - a String specifying the parameter name of the multipart file
    
    Returns:
    
    the uploaded content in the form of a MultipartFile object
  - getFiles
```
public java.util.List<MultipartFile> getFiles(java.lang.String name)
```
    Description copied from interface: MultipartRequest
    
    Return the contents plus description of uploaded files in this request, or an empty list if it does not exist.
    
    Specified by:
    
    getFiles in interface MultipartRequest
    
    Parameters:
    
    name - a String specifying the parameter name of the multipart file
    
    Returns:
    
    the uploaded content in the form of a MultipartFile list
  - getFileMap
```
public java.util.Map<java.lang.String,MultipartFile> getFileMap()
```
    Description copied from interface: MultipartRequest
    
    Return a <code>Map</code> of the multipart files contained in this request.
    
    Specified by:
    
    getFileMap in interface MultipartRequest
    
    Returns:
    
    a map containing the parameter names as keys, and the MultipartFile objects as values
  - getMultiFileMap
```
public MultiValueMap<java.lang.String,MultipartFile> getMultiFileMap()
```
    Description copied from interface: MultipartRequest
    
    Return a MultiValueMap of the multipart files contained in this request.
    
    Specified by:
    
    getMultiFileMap in interface MultipartRequest
    
    Returns:
    
    a map containing the parameter names as keys, and a list of MultipartFile objects as values
  - setMultipartFiles
```
protected final void setMultipartFiles(MultiValueMap<java.lang.String,MultipartFile> multipartFiles)
```
    Set a Map with parameter names as keys and list of MultipartFile objects as values. To be invoked by subclasses on initialization.
  - getMultipartFiles
```
protected MultiValueMap<java.lang.String,MultipartFile> getMultipartFiles()
```
    Obtain the MultipartFile Map for retrieval, lazily initializing it if necessary.
    
    See Also:
    
    initializeMultipart()
  - initializeMultipart
```
protected void initializeMultipart()
```
    Lazily initialize the multipart request, if possible. Only called if not already eagerly initialized.

Class AbstractMultipartHttpServletRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.web.multipart.MultipartHttpServletRequest

Methods inherited from interface org.springframework.web.multipart.MultipartRequest

Field Detail

multipartFiles

Constructor Detail

AbstractMultipartHttpServletRequest

Method Detail

getRequest

getRequestMethod

getRequestHeaders

getFileNames

getFile

getFiles

getFileMap

getMultiFileMap

setMultipartFiles

getMultipartFiles

initializeMultipart