/*
 * Copyright 2002-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.multipart.support;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;

import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.lang.Nullable;
import org.springframework.web.multipart.MultipartException;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.multipart.MultipartResolver;

ServerHttpRequest implementation that accesses one part of a multipart request. If using MultipartResolver configuration the part is accessed through a MultipartFile. Or if using Servlet 3.0 multipart processing the part is accessed through ServletRequest.getPart.
Author:Rossen Stoyanchev, Juergen Hoeller
Since:3.1
/** * {@link ServerHttpRequest} implementation that accesses one part of a multipart * request. If using {@link MultipartResolver} configuration the part is accessed * through a {@link MultipartFile}. Or if using Servlet 3.0 multipart processing * the part is accessed through {@code ServletRequest.getPart}. * * @author Rossen Stoyanchev * @author Juergen Hoeller * @since 3.1 */
public class RequestPartServletServerHttpRequest extends ServletServerHttpRequest { private final MultipartHttpServletRequest multipartRequest; private final String requestPartName; private final HttpHeaders multipartHeaders;
Create a new RequestPartServletServerHttpRequest instance.
Params:
  • request – the current servlet request
  • requestPartName – the name of the part to adapt to the ServerHttpRequest contract
Throws:
/** * Create a new {@code RequestPartServletServerHttpRequest} instance. * @param request the current servlet request * @param requestPartName the name of the part to adapt to the {@link ServerHttpRequest} contract * @throws MissingServletRequestPartException if the request part cannot be found * @throws MultipartException if MultipartHttpServletRequest cannot be initialized */
public RequestPartServletServerHttpRequest(HttpServletRequest request, String requestPartName) throws MissingServletRequestPartException { super(request); this.multipartRequest = MultipartResolutionDelegate.asMultipartHttpServletRequest(request); this.requestPartName = requestPartName; HttpHeaders multipartHeaders = this.multipartRequest.getMultipartHeaders(requestPartName); if (multipartHeaders == null) { throw new MissingServletRequestPartException(requestPartName); } this.multipartHeaders = multipartHeaders; } @Override public HttpHeaders getHeaders() { return this.multipartHeaders; } @Override public InputStream getBody() throws IOException { // Prefer Servlet Part resolution to cover file as well as parameter streams boolean servletParts = (this.multipartRequest instanceof StandardMultipartHttpServletRequest); if (servletParts) { Part part = retrieveServletPart(); if (part != null) { return part.getInputStream(); } } // Spring-style distinction between MultipartFile and String parameters MultipartFile file = this.multipartRequest.getFile(this.requestPartName); if (file != null) { return file.getInputStream(); } String paramValue = this.multipartRequest.getParameter(this.requestPartName); if (paramValue != null) { return new ByteArrayInputStream(paramValue.getBytes(determineCharset())); } // Fallback: Servlet Part resolution even if not indicated if (!servletParts) { Part part = retrieveServletPart(); if (part != null) { return part.getInputStream(); } } throw new IllegalStateException("No body available for request part '" + this.requestPartName + "'"); } @Nullable private Part retrieveServletPart() { try { return this.multipartRequest.getPart(this.requestPartName); } catch (Exception ex) { throw new MultipartException("Failed to retrieve request part '" + this.requestPartName + "'", ex); } } private Charset determineCharset() { MediaType contentType = getHeaders().getContentType(); if (contentType != null) { Charset charset = contentType.getCharset(); if (charset != null) { return charset; } } String encoding = this.multipartRequest.getCharacterEncoding(); return (encoding != null ? Charset.forName(encoding) : FORM_CHARSET); } }