root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Remove contentDispositionFormData with charset method 

The method was orginally added under SPR-14547 but the example in it
was probably intended for use with Content-Disposition server response
header (file dowonload) and not for a Content-Disposition header
within the body of a multipart request.

In a Spring application a multipart request is typically serialized
by the FormHttpMessageConverter and hence the Content-Disposition is
not explicitly set by the application.

Issue: SPR-15205
This commit is contained in:
Rossen Stoyanchev 2017-07-20 17:45:03 +02:00
parent d8a80fc0db
commit 3009e29489
2 changed files with 25 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
spring-web/src/main/java/org/springframework/http/ContentDisposition.java
View File

@ -27,8 +27,9 @@ import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import static java.nio.charset.StandardCharsets.*;
import static java.time.format.DateTimeFormatter.*;
import static java.nio.charset.StandardCharsets.ISO_8859_1;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.time.format.DateTimeFormatter.RFC_1123_DATE_TIME;
/**
* Represent the Content-Disposition type and parameters as defined in RFC 2183.
@ -416,8 +417,14 @@ public class ContentDisposition {
Builder filename(String filename);
/**
* Set the value of the {@literal filename*} that will be encoded as defined in
* the RFC 5987. Only the US-ASCII, UTF-8 and ISO-8859-1 charsets are supported.
* Set the value of the {@literal filename*} that will be encoded as
* defined in the RFC 5987. Only the US-ASCII, UTF-8 and ISO-8859-1
* charsets are supported.
* <p><strong>Note:</strong> Do not use this for a
* {@code "multipart/form-data"} requests as per
* <a link="https://tools.ietf.org/html/rfc7578#section-4.2">RFC 7578, Section 4.2</a>
* and also RFC 5987 itself mentions it does not apply to multipart
* requests.
*/
Builder filename(String filename, Charset charset);

47
spring-web/src/main/java/org/springframework/http/HttpHeaders.java
View File

@ -742,48 +742,32 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
}
/**
* Set the (new) value of the {@code Content-Disposition} header
* for {@code form-data}.
* Set the {@code Content-Disposition} header when creating a
* {@code "multipart/form-data"} request.
* <p>Applications typically would not set this header directly but
* rather prepare a {@code MultiValueMap<String, Object>}, containing an
* Object or a {@link org.springframework.core.io.Resource} for each part,
* and then pass that to the {@code RestTemplate} or {@code WebClient}.
* @param name the control name
* @param filename the filename (may be {@code null})
* @see #setContentDisposition(ContentDisposition)
* @see #getContentDisposition()
*/
public void setContentDispositionFormData(String name, @Nullable String filename) {
setContentDispositionFormData(name, filename, null);
}
/**
* Set the (new) value of the {@code Content-Disposition} header
* for {@code form-data}, optionally encoding the filename using the RFC 5987.
* <p>Only the US-ASCII, UTF-8 and ISO-8859-1 charsets are supported.
* @param name the control name
* @param filename the filename (may be {@code null})
* @param charset the charset used for the filename (may be {@code null})
* @since 4.3.3
* @see #setContentDisposition(ContentDisposition)
* @see #getContentDisposition()
* @see <a href="https://tools.ietf.org/html/rfc7230#section-3.2.4">RFC 7230 Section 3.2.4</a>
*/
public void setContentDispositionFormData(String name, @Nullable String filename, @Nullable Charset charset) {
Assert.notNull(name, "'name' must not be null");
ContentDisposition.Builder disposition = ContentDisposition.builder("form-data").name(name);
if (filename != null) {
if (charset != null) {
disposition.filename(filename, charset);
}
else {
disposition.filename(filename);
}
disposition.filename(filename);
}
setContentDisposition(disposition.build());
}
/**
* Set the (new) value of the {@literal Content-Disposition} header. Supports the
* disposition type and {@literal filename}, {@literal filename*} (encoded according
* to RFC 5987, only the US-ASCII, UTF-8 and ISO-8859-1 charsets are supported),
* {@literal name}, {@literal size} parameters.
* Set the {@literal Content-Disposition} header.
* <p>This could be used on a response to indicate if the content is
* expected to be displayed inline in the browser or as an attachment to be
* saved locally.
* <p>It can also be used for a {@code "multipart/form-data"} request.
* For more details see notes on {@link #setContentDispositionFormData}.
* @since 5.0
* @see #getContentDisposition()
*/
@ -792,10 +776,7 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
}
/**
* Return the {@literal Content-Disposition} header parsed as a {@link ContentDisposition}
* instance. Supports the disposition type and {@literal filename}, {@literal filename*}
* (encoded according to RFC 5987, only the US-ASCII, UTF-8 and ISO-8859-1 charsets are
* supported), {@literal name}, {@literal size} parameters.
* Return a parsed representation of the {@literal Content-Disposition} header.
* @since 5.0
* @see #setContentDisposition(ContentDisposition)
*/