You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by re...@apache.org on 2021/06/03 13:27:24 UTC
[cxf] branch master updated: CXF-8387: Allow special characters to
be used for a queryParam name. (#809)
This is an automated email from the ASF dual-hosted git repository.
reta pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cxf.git
The following commit(s) were added to refs/heads/master by this push:
new 88de27a CXF-8387: Allow special characters to be used for a queryParam name. (#809)
88de27a is described below
commit 88de27ade27695a295d392ef8cea96b72f841481
Author: Andriy Redko <dr...@gmail.com>
AuthorDate: Thu Jun 3 09:27:11 2021 -0400
CXF-8387: Allow special characters to be used for a queryParam name. (#809)
* CXF-8387: Allow special characters to be used for a queryParam name.
* Added a bit more test cases with templating
---
.../org/apache/cxf/jaxrs/utils/JAXRSUtils.java | 6 +-
.../apache/cxf/jaxrs/impl/UriBuilderImplTest.java | 111 +++++++++++++++++++++
.../org/apache/cxf/systest/jaxrs/BookStore.java | 11 ++
.../systest/jaxrs/JAXRS20ClientServerBookTest.java | 23 +++++
4 files changed, 150 insertions(+), 1 deletion(-)
diff --git a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/utils/JAXRSUtils.java b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/utils/JAXRSUtils.java
index bd09917..a9fd8d6 100644
--- a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/utils/JAXRSUtils.java
+++ b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/utils/JAXRSUtils.java
@@ -1368,7 +1368,11 @@ public final class JAXRSUtils {
}
}
- queries.add(HttpUtils.urlDecode(name), value);
+ if (decode) {
+ queries.add(HttpUtils.urlDecode(name), value);
+ } else {
+ queries.add(name, value);
+ }
}
private static Object readFromMessageBody(Class<?> targetTypeClass,
diff --git a/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/impl/UriBuilderImplTest.java b/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/impl/UriBuilderImplTest.java
index fb72e80..fe41e9e 100644
--- a/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/impl/UriBuilderImplTest.java
+++ b/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/impl/UriBuilderImplTest.java
@@ -21,6 +21,7 @@ package org.apache.cxf.jaxrs.impl;
import java.lang.reflect.Method;
import java.net.URI;
+import java.net.URLEncoder;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
@@ -1745,4 +1746,114 @@ public class UriBuilderImplTest {
}
}
+
+ @Test
+ public void testURIWithSpecialCharacters() {
+ final String expected = "http://localhost:8080/xy%22";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .path(URLEncoder.encode("xy\"")).build();
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ public void testURIWithSpecialCharacters2() {
+ final String expected = "http://localhost:8080/xy%09";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .path(URLEncoder.encode("xy\t"))
+ .buildFromEncoded();
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ public void testURIWithSpecialCharactersPreservePath() {
+ final String expected = "http://localhost:8080/xy/%22/abc";
+
+ final URI uri = UriBuilder.fromPath("")
+ .replacePath("http://localhost:8080")
+ .path("/{a}/{b}/{c}")
+ .buildFromEncoded("xy", "\"", "abc");
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ public void testURIWithSpecialCharactersPreservePath2() {
+ final String expected = "http://localhost:8080/xy/%09/abc";
+
+ final URI uri = UriBuilder.fromPath("")
+ .replacePath("http://localhost:8080")
+ .path("/{a}/{b}/{c}")
+ .buildFromEncoded("xy", "\t", "abc");
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ public void testIllegalURI() {
+ final String path = "invalidpath";
+
+ final URI uri = UriBuilder
+ .fromPath(path)
+ .build();
+
+ assertEquals(path, uri.toString());
+ }
+
+ @Test
+ @SuppressWarnings({"checkstyle:linelength"})
+ public void queryParamSpecialCharacters() {
+ final String expected = "http://localhost:8080?%2F%3FabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._%7E%251A%21%24%27%28%29*%2B%2C%3B%3A%40=apiKeyQueryParam1Value";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .queryParam(URLEncoder.encode("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@"), "apiKeyQueryParam1Value")
+ .build();
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ @SuppressWarnings({"checkstyle:linelength"})
+ public void queryParamSpecialCharactersFromEncoded() {
+ final String expected = "http://localhost:8080?%2F%3FabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._%7E%251A%21%24%27%28%29*%2B%2C%3B%3A%40=apiKeyQueryParam1Value";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .queryParam(URLEncoder.encode("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@"), "apiKeyQueryParam1Value")
+ .buildFromEncoded();
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ @SuppressWarnings({"checkstyle:linelength"})
+ public void queryParamSpecialCharactersFromEncodedTemplate() {
+ final String expected = "http://localhost:8080?%2F%3FabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._%7E%251A%21%24%27%28%29*%2B%2C%3B%3A%40=apiKeyQueryParam1Value";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .queryParam("{a}", "{b}")
+ .buildFromEncoded(URLEncoder.encode("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@"), "apiKeyQueryParam1Value");
+
+ assertEquals(expected, uri.toString());
+ }
+
+ @Test
+ @SuppressWarnings({"checkstyle:linelength"})
+ public void queryParamSpecialCharactersFromTemplate() {
+ final String expected = "http://localhost:8080?/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._%7E%251A%21%24%27%28%29*%2B,%3B%3A%40=apiKeyQueryParam1Value";
+
+ final URI uri = UriBuilder
+ .fromUri("http://localhost:8080")
+ .queryParam("{a}", "{b}")
+ .build("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@", "apiKeyQueryParam1Value");
+
+ assertEquals(expected, uri.toString());
+ }
}
\ No newline at end of file
diff --git a/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/BookStore.java b/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/BookStore.java
index cd434d5..2d6516e 100644
--- a/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/BookStore.java
+++ b/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/BookStore.java
@@ -1798,6 +1798,17 @@ public class BookStore {
public Response echoEntity(String entity) {
return Response.ok().entity(entity).build();
}
+
+ @GET
+ @Path("/queryParamSpecialCharacters")
+ @Produces("text/plain")
+ @SuppressWarnings({"checkstyle:linelength"})
+ public Response queryParamSpecialCharacters(@QueryParam("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@") String queryParm1) {
+ return Response
+ .ok(queryParm1)
+ .type(MediaType.TEXT_PLAIN)
+ .build();
+ }
public final String init() {
books.clear();
diff --git a/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/JAXRS20ClientServerBookTest.java b/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/JAXRS20ClientServerBookTest.java
index e6886b7..2f7c6a7 100644
--- a/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/JAXRS20ClientServerBookTest.java
+++ b/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/JAXRS20ClientServerBookTest.java
@@ -24,6 +24,7 @@ import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.net.URI;
+import java.net.URLEncoder;
import java.net.UnknownHostException;
import java.util.Arrays;
import java.util.Collections;
@@ -926,6 +927,28 @@ public class JAXRS20ClientServerBookTest extends AbstractBusClientServerTestBase
}
}
+ @Test
+ @SuppressWarnings({"checkstyle:linelength"})
+ public void testQueryParamSpecialCharactersEncoded() throws Exception {
+ final String address = "http://localhost:" + PORT + "/bookstore/queryParamSpecialCharacters";
+
+ try (Response response = ClientBuilder.newClient()
+ .register(AddHeaderClientResponseFilter.class)
+ .target(address)
+ .queryParam(URLEncoder.encode("/?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~%1A!$'()*+,;:@"),
+ "apiKeyQueryParam1Value")
+ .request(MediaType.TEXT_PLAIN)
+ .get()) {
+ assertEquals(200, response.getStatus());
+
+ final String actual = response.readEntity(String.class);
+ final String expected = "apiKeyQueryParam1Value";
+
+ assertEquals(expected, actual);
+ }
+ }
+
+
private static class ReplaceBodyFilter implements ClientRequestFilter {
@Override