Support for Servlet request params with HTTP DELETE
This commit adds FormContentFilter, which is the same as the HttpPutFormContentFilter but also supports DELETE. The HttpPutFormContentFilter is now deprecated. Issue: SPR-16874
This commit is contained in:
Rossen Stoyanchev
@@ -0,0 +1,218 @@
|
||||
/*
|
||||
* Copyright 2002-2018 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
|
||||
*
|
||||
* http://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.filter;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.http.HttpMethod;
|
||||
import org.springframework.mock.web.test.MockFilterChain;
|
||||
import org.springframework.mock.web.test.MockHttpServletRequest;
|
||||
import org.springframework.mock.web.test.MockHttpServletResponse;
|
||||
|
||||
import static org.junit.Assert.*;
|
||||
|
||||
/**
|
||||
* Test fixture for {@link FormContentFilter}.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
*/
|
||||
public class FormContentFilterTests {
|
||||
|
||||
private final FormContentFilter filter = new FormContentFilter();
|
||||
|
||||
private MockHttpServletRequest request;
|
||||
|
||||
private MockHttpServletResponse response;
|
||||
|
||||
private MockFilterChain filterChain;
|
||||
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
this.request = new MockHttpServletRequest("PUT", "/");
|
||||
this.request.addHeader("Content-Type", "application/x-www-form-urlencoded; charset=ISO-8859-1");
|
||||
this.request.setContentType("application/x-www-form-urlencoded; charset=ISO-8859-1");
|
||||
this.response = new MockHttpServletResponse();
|
||||
this.filterChain = new MockFilterChain();
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void wrapPutPatchAndDeleteOnly() throws Exception {
|
||||
this.request.setContent("foo=bar".getBytes("ISO-8859-1"));
|
||||
for (HttpMethod method : HttpMethod.values()) {
|
||||
this.request.setMethod(method.name());
|
||||
this.filterChain = new MockFilterChain();
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
if (method == HttpMethod.PUT || method == HttpMethod.PATCH || method == HttpMethod.DELETE) {
|
||||
assertNotSame(this.request, this.filterChain.getRequest());
|
||||
}
|
||||
else {
|
||||
assertSame(this.request, this.filterChain.getRequest());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void wrapFormEncodedOnly() throws Exception {
|
||||
this.request.setContent("".getBytes("ISO-8859-1"));
|
||||
String[] contentTypes = new String[] {"text/plain", "multipart/form-data"};
|
||||
for (String contentType : contentTypes) {
|
||||
this.request.setContentType(contentType);
|
||||
this.filterChain = new MockFilterChain();
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
assertSame(this.request, this.filterChain.getRequest());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void invalidMediaType() throws Exception {
|
||||
this.request.setContent("".getBytes("ISO-8859-1"));
|
||||
this.request.setContentType("foo");
|
||||
this.filterChain = new MockFilterChain();
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
assertSame(this.request, this.filterChain.getRequest());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameter() throws Exception {
|
||||
this.request.setContent("name=value".getBytes("ISO-8859-1"));
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
|
||||
assertEquals("value", this.filterChain.getRequest().getParameter("name"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterFromQueryString() throws Exception {
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.setContent("name=value2".getBytes("ISO-8859-1"));
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertEquals("Query string parameters should be listed ahead of form parameters",
|
||||
"value1", this.filterChain.getRequest().getParameter("name"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterNullValue() throws Exception {
|
||||
this.request.setContent("name=value".getBytes("ISO-8859-1"));
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertNull(this.filterChain.getRequest().getParameter("noSuchParam"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterNames() throws Exception {
|
||||
this.request.addParameter("name1", "value1");
|
||||
this.request.addParameter("name2", "value2");
|
||||
this.request.setContent("name1=value1&name3=value3&name4=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
List<String> names = Collections.list(this.filterChain.getRequest().getParameterNames());
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertEquals(Arrays.asList("name1", "name2", "name3", "name4"), names);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValues() throws Exception {
|
||||
this.request.setQueryString("name=value1&name=value2");
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.addParameter("name", "value2");
|
||||
this.request.setContent("name=value3&name=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
String[] values = this.filterChain.getRequest().getParameterValues("name");
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"value1", "value2", "value3", "value4"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesFromQueryString() throws Exception {
|
||||
this.request.setQueryString("name=value1&name=value2");
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.addParameter("name", "value2");
|
||||
this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
String[] values = this.filterChain.getRequest().getParameterValues("name");
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"value1", "value2"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesFromFormContent() throws Exception {
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.addParameter("name", "value2");
|
||||
this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
String[] values = this.filterChain.getRequest().getParameterValues("anotherName");
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"anotherValue"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesInvalidName() throws Exception {
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.addParameter("name", "value2");
|
||||
this.request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
String[] values = this.filterChain.getRequest().getParameterValues("noSuchParameter");
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertNull(values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterMap() throws Exception {
|
||||
this.request.setQueryString("name=value1&name=value2");
|
||||
this.request.addParameter("name", "value1");
|
||||
this.request.addParameter("name", "value2");
|
||||
this.request.setContent("name=value3&name4=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
Map<String, String[]> parameters = this.filterChain.getRequest().getParameterMap();
|
||||
|
||||
assertNotSame("Request not wrapped", this.request, this.filterChain.getRequest());
|
||||
assertEquals(2, parameters.size());
|
||||
assertArrayEquals(new String[] {"value1", "value2", "value3"}, parameters.get("name"));
|
||||
assertArrayEquals(new String[] {"value4"}, parameters.get("name4"));
|
||||
}
|
||||
|
||||
@Test // SPR-15835
|
||||
public void hiddenHttpMethodFilterFollowedByHttpPutFormContentFilter() throws Exception {
|
||||
this.request.addParameter("_method", "PUT");
|
||||
this.request.addParameter("hiddenField", "testHidden");
|
||||
this.filter.doFilter(this.request, this.response, this.filterChain);
|
||||
|
||||
assertArrayEquals(new String[]{"testHidden"},
|
||||
this.filterChain.getRequest().getParameterValues("hiddenField"));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,218 +0,0 @@
|
||||
/*
|
||||
* Copyright 2002-2018 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
|
||||
*
|
||||
* http://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.filter;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.http.HttpMethod;
|
||||
import org.springframework.mock.web.test.MockFilterChain;
|
||||
import org.springframework.mock.web.test.MockHttpServletRequest;
|
||||
import org.springframework.mock.web.test.MockHttpServletResponse;
|
||||
|
||||
import static org.junit.Assert.*;
|
||||
|
||||
/**
|
||||
* Test fixture for {@link HttpPutFormContentFilter}.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
*/
|
||||
public class HttpPutFormContentFilterTests {
|
||||
|
||||
private HttpPutFormContentFilter filter;
|
||||
|
||||
private MockHttpServletRequest request;
|
||||
|
||||
private MockHttpServletResponse response;
|
||||
|
||||
private MockFilterChain filterChain;
|
||||
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
filter = new HttpPutFormContentFilter();
|
||||
request = new MockHttpServletRequest("PUT", "/");
|
||||
request.addHeader("Content-Type", "application/x-www-form-urlencoded; charset=ISO-8859-1");
|
||||
request.setContentType("application/x-www-form-urlencoded; charset=ISO-8859-1");
|
||||
response = new MockHttpServletResponse();
|
||||
filterChain = new MockFilterChain();
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void wrapPutAndPatchOnly() throws Exception {
|
||||
request.setContent("foo=bar".getBytes("ISO-8859-1"));
|
||||
for (HttpMethod method : HttpMethod.values()) {
|
||||
request.setMethod(method.name());
|
||||
filterChain = new MockFilterChain();
|
||||
filter.doFilter(request, response, filterChain);
|
||||
if (method == HttpMethod.PUT || method == HttpMethod.PATCH) {
|
||||
assertNotSame("Should wrap HTTP method " + method, request, filterChain.getRequest());
|
||||
}
|
||||
else {
|
||||
assertSame("Should not wrap for HTTP method " + method, request, filterChain.getRequest());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void wrapFormEncodedOnly() throws Exception {
|
||||
request.setContent("".getBytes("ISO-8859-1"));
|
||||
String[] contentTypes = new String[] {"text/plain", "multipart/form-data"};
|
||||
for (String contentType : contentTypes) {
|
||||
request.setContentType(contentType);
|
||||
filterChain = new MockFilterChain();
|
||||
filter.doFilter(request, response, filterChain);
|
||||
assertSame("Should not wrap for content type " + contentType, request, filterChain.getRequest());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void invalidMediaType() throws Exception {
|
||||
request.setContent("".getBytes("ISO-8859-1"));
|
||||
request.setContentType("foo");
|
||||
filterChain = new MockFilterChain();
|
||||
filter.doFilter(request, response, filterChain);
|
||||
assertSame(request, filterChain.getRequest());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameter() throws Exception {
|
||||
request.setContent("name=value".getBytes("ISO-8859-1"));
|
||||
filter.doFilter(request, response, filterChain);
|
||||
|
||||
assertEquals("value", filterChain.getRequest().getParameter("name"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterFromQueryString() throws Exception {
|
||||
request.addParameter("name", "value1");
|
||||
request.setContent("name=value2".getBytes("ISO-8859-1"));
|
||||
filter.doFilter(request, response, filterChain);
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertEquals("Query string parameters should be listed ahead of form parameters",
|
||||
"value1", filterChain.getRequest().getParameter("name"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterNullValue() throws Exception {
|
||||
request.setContent("name=value".getBytes("ISO-8859-1"));
|
||||
filter.doFilter(request, response, filterChain);
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertNull(filterChain.getRequest().getParameter("noSuchParam"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterNames() throws Exception {
|
||||
request.addParameter("name1", "value1");
|
||||
request.addParameter("name2", "value2");
|
||||
request.setContent("name1=value1&name3=value3&name4=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
List<String> names = Collections.list(filterChain.getRequest().getParameterNames());
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertEquals(Arrays.asList("name1", "name2", "name3", "name4"), names);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValues() throws Exception {
|
||||
request.setQueryString("name=value1&name=value2");
|
||||
request.addParameter("name", "value1");
|
||||
request.addParameter("name", "value2");
|
||||
request.setContent("name=value3&name=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
String[] values = filterChain.getRequest().getParameterValues("name");
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"value1", "value2", "value3", "value4"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesFromQueryString() throws Exception {
|
||||
request.setQueryString("name=value1&name=value2");
|
||||
request.addParameter("name", "value1");
|
||||
request.addParameter("name", "value2");
|
||||
request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
String[] values = filterChain.getRequest().getParameterValues("name");
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"value1", "value2"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesFromFormContent() throws Exception {
|
||||
request.addParameter("name", "value1");
|
||||
request.addParameter("name", "value2");
|
||||
request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
String[] values = filterChain.getRequest().getParameterValues("anotherName");
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertArrayEquals(new String[]{"anotherValue"}, values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterValuesInvalidName() throws Exception {
|
||||
request.addParameter("name", "value1");
|
||||
request.addParameter("name", "value2");
|
||||
request.setContent("anotherName=anotherValue".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
String[] values = filterChain.getRequest().getParameterValues("noSuchParameter");
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertNull(values);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getParameterMap() throws Exception {
|
||||
request.setQueryString("name=value1&name=value2");
|
||||
request.addParameter("name", "value1");
|
||||
request.addParameter("name", "value2");
|
||||
request.setContent("name=value3&name4=value4".getBytes("ISO-8859-1"));
|
||||
|
||||
filter.doFilter(request, response, filterChain);
|
||||
Map<String, String[]> parameters = filterChain.getRequest().getParameterMap();
|
||||
|
||||
assertNotSame("Request not wrapped", request, filterChain.getRequest());
|
||||
assertEquals(2, parameters.size());
|
||||
assertArrayEquals(new String[] {"value1", "value2", "value3"}, parameters.get("name"));
|
||||
assertArrayEquals(new String[] {"value4"}, parameters.get("name4"));
|
||||
}
|
||||
|
||||
@Test // SPR-15835
|
||||
public void hiddenHttpMethodFilterFollowedByHttpPutFormContentFilter() throws Exception {
|
||||
request.addParameter("_method", "PUT");
|
||||
request.addParameter("hiddenField", "testHidden");
|
||||
filter.doFilter(request, response, filterChain);
|
||||
|
||||
assertArrayEquals(new String[]{"testHidden"}, filterChain.getRequest().getParameterValues("hiddenField"));
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user