Clear URI-path or -query options on setURI.

Issue eclipse-californium#1894

Signed-off-by: Achim Kraus <[email protected]>

Author: Achim Kraus

californium-core/src/main/java/org/eclipse/californium/core/coap/OptionSet.java

@@ -88,13 +88,6 @@ public final class OptionSet {
 	// Arbitrary options
 	private List<Option> others;
 
-	/**
-	 * {@code true}, if URI-path or URI-query are set independent from
-	 * {@link Request#setURI}. Preserve them from being cleaned up, if the URI
-	 * doesn't contain them.
-	 */
-	private boolean explicitUriOptions;
-
 	/**
 	 * Creates an empty set of options.
 	 * <p>
@@ -307,7 +300,7 @@ public OptionSet clearIfMatchs() {
 	/**
 	 * Gets the string value of the Uri-Host option.
 	 * 
-	 * @return the Uri-Host or null if the option is not present
+	 * @return the Uri-Host, or {@code null}, if the option is not present
 	 */
 	public String getUriHost() {
 		return uri_host;
@@ -691,7 +684,6 @@ public OptionSet setUriPath(String path) {
 	public OptionSet addUriPath(String segment) {
 		checkOptionValue(OptionNumberRegistry.URI_PATH, segment);
 		getUriPath().add(segment);
-		this.explicitUriOptions = true;
 		return this;
 	}
 
@@ -886,7 +878,6 @@ public OptionSet setUriQuery(String query) {
 	public OptionSet addUriQuery(String argument) {
 		checkOptionValue(OptionNumberRegistry.URI_QUERY, argument);
 		getUriQuery().add(argument);
-		this.explicitUriOptions = true;
 		return this;
 	}
 
@@ -1604,14 +1595,6 @@ public List<Option> asSortedList() {
 		return options;
 	}
 
-	boolean hasExplicitUriOptions() {
-		return explicitUriOptions;
-	}
-
-	void resetExplicitUriOptions() {
-		explicitUriOptions = false;
-	}
-
 	/**
 	 * Add options.
 	 * 

californium-core/src/main/java/org/eclipse/californium/core/coap/Request.java

@@ -411,21 +411,12 @@ public Request setProxyScheme(String proxyScheme) {
 	 * options directly in the optons-set using {@link #getOptions()}.
 	 * </p>
 	 * <p>
-	 * Note: if the URI contains a hostname, a DNS lookup may be used to
-	 * resolve the address. That may block for a unknown time. To prevent from
-	 * that, the address may be resolved ahead by {@link InetAddress#getByName(String)}.
+	 * Note: if the URI contains a hostname, a DNS lookup may be used to resolve
+	 * the address. That may block for a unknown time. To prevent from that, the
+	 * address may be resolved ahead by {@link InetAddress#getByName(String)}.
 	 * </p>
-	 * Note: if uri-path or uri-query option was set explicitly before, they are
-	 * not cleaned up, if the URI doesn't contain that part. e.g.
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path")} results in
-	 * {@code "coap://host/path?param=2"}. But
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path?mark")} results in
-	 * {@code "coap://host/path?mark"}.
-	 * 
-	 * That will be removed in the next major version! Don't set uri-path or
-	 * uri-query options before the URI!
+	 * Note: since 3.3, uri-path or uri-query options, if required, must be set
+	 * after the URI! The URI will clean them, if not contained in the URI.
 	 * 
 	 * Provides a fluent API to chain setters.
 	 * 
@@ -473,17 +464,8 @@ public Request setURI(final String uri) {
 	 * resolve the address. That may block for a unknown time. To prevent from
 	 * that, the address may be resolved ahead by {@link InetAddress#getByName(String)}.
 	 * <p>
-	 * Note: if uri-path or uri-query option was set explicitly before, they are
-	 * not cleaned up, if the URI doesn't contain that part. e.g.
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path")} results in
-	 * {@code "coap://host/path?param=2"}. But
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path?mark")} results in
-	 * {@code "coap://host/path?mark"}.
-	 * 
-	 * That will be removed in the next major version! Don't set uri-path or
-	 * uri-query options before the URI!
+	 * Note: since 3.3, uri-path or uri-query options, if required, must be set
+	 * after the URI! The URI will clean them, if not contained in the URI.
 	 * 
 	 * Provides a fluent API to chain setters.
 	 * 
@@ -537,17 +519,8 @@ public Request setURI(final URI uri) {
 	 * strict proxy/CoAP URI exclusion for backwards compatibility, set the
 	 * options directly in the optons-set using {@link #getOptions()}.
 	 * </p>
-	 * Note: if uri-path or uri-query option was set explicitly before, they are
-	 * not cleaned up, if the URI doesn't contain that part. e.g.
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path")} results in
-	 * {@code "coap://host/path?param=2"}. But
-	 * {@code request.getOptions().setUriQuery("param=2")} and
-	 * {@code request.setURI("coap://host/path?mark")} results in
-	 * {@code "coap://host/path?mark"}.
-	 * 
-	 * That will be removed in the next major version! Don't set uri-path or
-	 * uri-query options before the URI!
+	 * Note: since 3.3, uri-path or uri-query options, if required, must be set
+	 * after the URI! The URI will clean them, if not contained in the URI.
 	 * 
 	 * Provides a fluent API to chain setters.
 	 * 
@@ -620,7 +593,6 @@ private void setOptionsInternal(URI uri, InetSocketAddress destination, boolean
 			throw new NullPointerException("destination address must not be null!");
 		}
 		OptionSet options = getOptions();
-		boolean explicitUriOption = options.hasExplicitUriOptions();
 		String host = uri.getHost();
 
 		if (host != null) {
@@ -670,19 +642,16 @@ private void setOptionsInternal(URI uri, InetSocketAddress destination, boolean
 		String path = uri.getPath();
 		if (path != null && path.length() > 1) {
 			options.setUriPath(path);
-		} else if (!explicitUriOption) {
+		} else {
 			options.clearUriPath();
 		}
 		// set Uri-Query options
 		String query = uri.getQuery();
 		if (query != null) {
 			options.setUriQuery(query);
-		} else if (!explicitUriOption) {
+		} else {
 			options.clearUriQuery();
 		}
-		if (!explicitUriOption) {
-			options.resetExplicitUriOptions();
-		}
 	}
 
 	/**

californium-core/src/test/java/org/eclipse/californium/core/coap/RequestTest.java

@@ -274,11 +274,11 @@ public void testSetURITwice() throws UnknownHostException {
 		assertThat(req.getOptions().getUriPathString(), is("test2"));
 		assertThat(req.getOptions().getURIQueryCount(), is(0));
 
-		// only for 2.x.y, in 3.x.y the uri-query option must be set after the URI  
+		// since 3.3, a preset uri-query option is cleared by the URI  
 		req.getOptions().addUriQuery("param2");
 		req.setURI("coap://192.168.0.1/test2");
 		assertThat(req.getOptions().getUriPathString(), is("test2"));
-		assertThat(req.getOptions().getUriQueryString(), is("param2"));
+		assertThat(req.getOptions().getURIQueryCount(), is(0));
 	}
 
 	@Test(expected = IllegalStateException.class)