Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecate setContentDispositionFormData method

Browse Source 
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 download) 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.
This commit is contained in:
Rossen Stoyanchev
2017-07-20 17:58:52 +02:00
parent 0e8bd71d53
commit cd602e5904
2 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -670,13 +670,24 @@ 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})
*/
public void setContentDispositionFormData(String name, String filename) {
setContentDispositionFormData(name, filename, null);
Assert.notNull(name, "'name' must not be null");
StringBuilder builder = new StringBuilder("form-data; name=\"");
builder.append(name).append('\"');
if (filename != null) {
builder.append("; filename=\"");
builder.append(filename).append('\"');
}
set(CONTENT_DISPOSITION, builder.toString());
}
/**
@@ -686,10 +697,14 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
* @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 #setContentDispositionFormData(String, String)
* @see <a href="https://tools.ietf.org/html/rfc7230#section-3.2.4">RFC 7230 Section 3.2.4</a>
* @deprecated deprecated in 4.3.11 and removed from 5.0; as per
* <a link="https://tools.ietf.org/html/rfc7578#section-4.2">RFC 7578, Section 4.2</a>,
* an RFC 5987 style encoding should not be used for multipart/form-data requests.
* Furthermore there should be no reason for applications to set this header
* explicitly; for more details also read
* {@link #setContentDispositionFormData(String, String)}
*/
@Deprecated
public void setContentDispositionFormData(String name, String filename, Charset charset) {
Assert.notNull(name, "'name' must not be null");
StringBuilder builder = new StringBuilder("form-data; name=\"");