fix(#1437) Deprecate html, fileupload and httpclient extensions (#1438)

thboileau · web-flow · commit ae6da2442878 · 2024-12-27T11:08:56.000+01:00
diff --git a/changes.md b/changes.md
@@ -15,7 +15,7 @@ Changes log
       - Removed deprecation of GWT extension as the new intent is to keep the GWT edition and extension maintained in the new
         major 2.6 release.
       - Deprecated extensions (Apache) HTTP Client, HTML and (Apache) FileUpload as we intend to remove them in version 2.6 to
-        rely instead on the Jetty extension for a more robust alternative. 
+        rely instead on the Jetty extension for a more robust alternative. Issue #1437.
 
 - 2.5 Release Candidate 1 (12-11-2024)
     - Enhancements
diff --git a/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/RepresentationContext.java b/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/RepresentationContext.java
@@ -20,7 +20,9 @@
  * processor.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class RepresentationContext implements UploadContext  {
 
     /** The representation to adapt. */
diff --git a/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/RestletFileUpload.java b/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/RestletFileUpload.java
@@ -40,7 +40,9 @@
  * method.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class RestletFileUpload extends FileUpload {
 	/**
 	 * Determines if the request has multipart content.
diff --git a/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/package.html b/org.restlet.java/org.restlet.ext.fileupload/src/main/java/org/restlet/ext/fileupload/package.html
@@ -5,5 +5,6 @@
 @since Restlet 1.0
 @see <a href="https://commons.apache.org/proper/commons-fileupload/">Apache Commons FileUpload</a>
 @see <a href="https://restlet.talend.com/documentation/user-guide/2.5/extensions/fileupload">User Guide - Apache FileUpload extension</a>
+@deprecated Will be removed in next minor release in favor or Jetty extension.
 </BODY>
 </HTML>
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/FormData.java b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/FormData.java
@@ -26,7 +26,9 @@
  * as a binary file uploaded).
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class FormData implements NamedValue<String> {
 
     /** The name of the associated form control. */
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/FormDataSet.java b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/FormDataSet.java
@@ -28,7 +28,9 @@
  * HTML form supporting either URL encoding or multipart encoding.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class FormDataSet extends OutputRepresentation {
 
     /** The default boundary separating multipart entries. */
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/HtmlConverter.java b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/HtmlConverter.java
@@ -24,7 +24,9 @@
  * Converter between the HTML API and Representation classes.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class HtmlConverter extends ConverterHelper {
 
     private static final VariantInfo VARIANT_MULTIPART = new VariantInfo(
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/internal/FormReader.java b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/internal/FormReader.java
@@ -28,7 +28,9 @@
  * Form reader.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class FormReader {
 
     /** The encoding to use, decoding is enabled, see {@link #decoding}. */
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/internal/FormUtils.java b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/internal/FormUtils.java
@@ -27,7 +27,9 @@
  * Representation of a Web form containing submitted entries.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class FormUtils {
 
     /**
diff --git a/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/package.html b/org.restlet.java/org.restlet.ext.html/src/main/java/org/restlet/ext/html/package.html
@@ -5,5 +5,6 @@
 @since Restlet 2.1
 @see <a href="http://www.w3.org/TR/html4/">W3C HTML 4.0 specification</a>
 @see <a href="https://restlet.talend.com/documentation/user-guide/2.5/extensions/html">User Guide - HTML extension</a>
+@deprecated Will be removed in next minor release in favor or Jetty extension.
 </BODY>
 </HTML>
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/HttpClientHelper.java b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/HttpClientHelper.java
@@ -171,7 +171,9 @@
  *      href="https://docs.oracle.com/javase/1.5.0/docs/guide/net/index.html">Networking
  *      Features</a>
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class HttpClientHelper extends
         org.restlet.engine.adapter.HttpClientHelper {
     private volatile DefaultHttpClient httpClient;
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/HttpIdleConnectionReaper.java b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/HttpIdleConnectionReaper.java
@@ -20,7 +20,9 @@
  * is equal to 0.
  * 
  * @author Sanjay Acharya
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class HttpIdleConnectionReaper {
 
     /**
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/HttpMethodCall.java b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/HttpMethodCall.java
@@ -48,7 +48,9 @@
  * HTTP client connector call based on Apache HTTP Client's HttpMethod class.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class HttpMethodCall extends ClientCall {
 
     /** The associated HTTP client. */
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/IgnoreCookieSpec.java b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/IgnoreCookieSpec.java
@@ -22,7 +22,9 @@
  * Cookie specifications that ignore all cookies.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class IgnoreCookieSpec extends CookieSpecBase {
 
     /**
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/IgnoreCookieSpecFactory.java b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/internal/IgnoreCookieSpecFactory.java
@@ -17,7 +17,9 @@
  * Factory that creates {@link IgnoreCookieSpec} instances.
  * 
  * @author Jerome Louvel
+ * @deprecated Will be removed in next minor release in favor or Jetty extension.
  */
+@Deprecated
 public class IgnoreCookieSpecFactory implements CookieSpecFactory {
 
     /**
diff --git a/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/package.html b/org.restlet.java/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/package.html
@@ -7,5 +7,6 @@
 @since Restlet 1.0
 @see <a href="https://hc.apache.org/httpcomponents-client-4.5.x/">Apache HTTP client project</a>
 @see <a href="https://restlet.talend.com/documentation/user-guide/2.5/extensions/httpclient">User Guide - Apache HTTP Client extension</a>
+@deprecated Will be removed in next minor release in favor or Jetty extension.
 </BODY>
 </HTML>

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@`
`20`	`20`	`* processor.`
`21`	`21`	`*`
`22`	`22`	`* @author Jerome Louvel`
	`23`	`+ * @deprecated Will be removed in next minor release in favor or Jetty extension.`
`23`	`24`	`*/`
	`25`	`+@Deprecated`
`24`	`26`	`public class RepresentationContext implements UploadContext {`
`25`	`27`
`26`	`28`	`/** The representation to adapt. */`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,9 @@`
`26`	`26`	`* as a binary file uploaded).`
`27`	`27`	`*`
`28`	`28`	`* @author Jerome Louvel`
	`29`	`+ * @deprecated Will be removed in next minor release in favor or Jetty extension.`
`29`	`30`	`*/`
	`31`	`+@Deprecated`
`30`	`32`	`public class FormData implements NamedValue<String> {`
`31`	`33`
`32`	`34`	`/** The name of the associated form control. */`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@`
`28`	`28`	`* HTML form supporting either URL encoding or multipart encoding.`
`29`	`29`	`*`
`30`	`30`	`* @author Jerome Louvel`
	`31`	`+ * @deprecated Will be removed in next minor release in favor or Jetty extension.`
`31`	`32`	`*/`
	`33`	`+@Deprecated`
`32`	`34`	`public class FormDataSet extends OutputRepresentation {`
`33`	`35`
`34`	`36`	`/** The default boundary separating multipart entries. */`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,9 @@`
`24`	`24`	`* Converter between the HTML API and Representation classes.`
`25`	`25`	`*`
`26`	`26`	`* @author Jerome Louvel`
	`27`	`+ * @deprecated Will be removed in next minor release in favor or Jetty extension.`
`27`	`28`	`*/`
	`29`	`+@Deprecated`
`28`	`30`	`public class HtmlConverter extends ConverterHelper {`
`29`	`31`
`30`	`32`	`private static final VariantInfo VARIANT_MULTIPART = new VariantInfo(`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,9 @@`
`27`	`27`	`* Representation of a Web form containing submitted entries.`
`28`	`28`	`*`
`29`	`29`	`* @author Jerome Louvel`
	`30`	`+ * @deprecated Will be removed in next minor release in favor or Jetty extension.`
`30`	`31`	`*/`
	`32`	`+@Deprecated`
`31`	`33`	`public class FormUtils {`
`32`	`34`
`33`	`35`	`/**`