This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-dev.git
The following commit(s) were added to refs/heads/master by this push:
new c73a22590b FELIX-6639 : Deprecate all javax.servlet related API
c73a22590b is described below
commit c73a22590b36538f524407e14b77ea66071bced2
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Sun Aug 27 10:56:28 2023 +0200
FELIX-6639 : Deprecate all javax.servlet related API
---
webconsole/pom.xml | 2 +-
.../org/apache/felix/webconsole/AbstractWebConsolePlugin.java | 6 ++++--
.../java/org/apache/felix/webconsole/SimpleWebConsolePlugin.java | 3 +++
.../java/org/apache/felix/webconsole/WebConsoleConstants.java | 3 +++
.../org/apache/felix/webconsole/WebConsoleSecurityProvider.java | 2 ++
.../org/apache/felix/webconsole/WebConsoleSecurityProvider2.java | 2 ++
.../org/apache/felix/webconsole/WebConsoleSecurityProvider3.java | 2 ++
.../src/main/java/org/apache/felix/webconsole/WebConsoleUtil.java | 8 +++++---
.../felix/webconsole/internal/servlet/JakartaServletAdapter.java | 1 -
.../org/apache/felix/webconsole/internal/servlet/OsgiManager.java | 2 +-
.../java/org/apache/felix/webconsole/servlet/AbstractServlet.java | 1 -
.../apache/felix/webconsole/servlet/RequestVariableResolver.java | 4 ++--
.../org/apache/felix/webconsole/servlet/ServletConstants.java | 1 -
.../src/main/java/org/apache/felix/webconsole/servlet/User.java | 1 -
14 files changed, 25 insertions(+), 13 deletions(-)
diff --git a/webconsole/pom.xml b/webconsole/pom.xml
index 68bc1d4808..e46ec683bc 100644
--- a/webconsole/pom.xml
+++ b/webconsole/pom.xml
@@ -171,7 +171,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<excludePackageNames>
- *.internal
+ *.internal.*:*.internal
</excludePackageNames>
</configuration>
</plugin>
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
b/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
index 6d5b91a3de..7febb000b2 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
@@ -62,7 +62,10 @@ import org.osgi.service.log.LogService;
* To help rendering the response the Apache Felix Web Console bundle provides
two
* options. One of the options is to extend the AbstractWebConsolePlugin
overwriting
* the {@link #renderContent(HttpServletRequest, HttpServletResponse)} method.
+ *
+ * @deprecated Either register a servlet using Servlet API 5 or use {@link
org.apache.felix.webconsole.servlet.AbstractServlet}
*/
+@Deprecated
public abstract class AbstractWebConsolePlugin extends HttpServlet {
/** Pseudo class version ID to keep the IDE quite. */
@@ -135,7 +138,6 @@ public abstract class AbstractWebConsolePlugin extends
HttpServlet {
private BundleContext bundleContext;
- @SuppressWarnings("deprecation")
private static volatile BrandingPlugin brandingPlugin =
DefaultBrandingPlugin.getInstance();
private static volatile int logLevel;
@@ -671,7 +673,7 @@ public abstract class AbstractWebConsolePlugin extends
HttpServlet {
* @param request the HTTP request coming from the user
* @param pw the writer, where the HTML data is rendered
*/
- @SuppressWarnings({ "rawtypes", "deprecation" })
+ @SuppressWarnings({ "rawtypes" })
protected void renderTopNavigation( HttpServletRequest request,
PrintWriter pw )
{
// assume pathInfo to not be null, else this would not be called
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/SimpleWebConsolePlugin.java
b/webconsole/src/main/java/org/apache/felix/webconsole/SimpleWebConsolePlugin.java
index b0abba0e1d..e2a44b227b 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/SimpleWebConsolePlugin.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/SimpleWebConsolePlugin.java
@@ -47,7 +47,10 @@ import org.osgi.util.tracker.ServiceTrackerCustomizer;
* <li>Methods for (un)registering the web console plugin service</li>
* <li>Default implementation for resource loading</li>
* </ul>
+ *
+ * @deprecated Either register a servlet using Servlet API 5 or use {@link
org.apache.felix.webconsole.servlet.AbstractServlet}
*/
+@Deprecated
public abstract class SimpleWebConsolePlugin extends AbstractWebConsolePlugin
{
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleConstants.java
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleConstants.java
index d87e747f42..a9c30da3da 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleConstants.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleConstants.java
@@ -23,7 +23,10 @@ import
org.apache.felix.webconsole.servlet.RequestVariableResolver;
/**
* WebConsoleConstants provides some common constants that are used by plugin
* developers.
+ *
+ * @deprecated Either register a servlet using Servlet API 5 or use {@link
org.apache.felix.webconsole.servlet.AbstractServlet}
*/
+@Deprecated
public interface WebConsoleConstants {
/**
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider.java
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider.java
index 7d18e7bf85..adf5a73e55 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider.java
@@ -26,7 +26,9 @@ import org.osgi.annotation.versioning.ConsumerType;
* Web Console.
*
* @since 3.1.0; Web Console Bundle 3.1.0
+ * @deprecated Use the {@link
org.apache.felix.webconsole.spi.SecurityProvider} instead.
*/
+@Deprecated
@ConsumerType
public interface WebConsoleSecurityProvider {
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider2.java
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider2.java
index 8a91e2c4b1..b08c439d5f 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider2.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider2.java
@@ -36,7 +36,9 @@ import org.osgi.annotation.versioning.ConsumerType;
* {@link WebConsoleSecurityProvider#authenticate(String, String)} method.
*
* @since 3.1.2; Web Console Bundle 3.1.4
+ * @deprecated Use the {@link
org.apache.felix.webconsole.spi.SecurityProvider} instead.
*/
+@Deprecated
@ConsumerType
public interface WebConsoleSecurityProvider2 extends
WebConsoleSecurityProvider {
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider3.java
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider3.java
index 9f479807bd..97e473a5d7 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider3.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleSecurityProvider3.java
@@ -38,7 +38,9 @@ import org.osgi.service.http.context.ServletContextHelper;
* {@link ServletContextHelper#REMOTE_USER}, {@link
ServletContextHelper#AUTHORIZATION} attributes from the request and the session.
*
* @since 4.2.8; Web Console Bundle 4.2.8
+ * @deprecated Use the {@link
org.apache.felix.webconsole.spi.SecurityProvider} instead.
*/
+@Deprecated
@ConsumerType
public interface WebConsoleSecurityProvider3 extends
WebConsoleSecurityProvider2 {
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleUtil.java
b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleUtil.java
index 66974cf3dc..2f6c2c6552 100644
--- a/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleUtil.java
+++ b/webconsole/src/main/java/org/apache/felix/webconsole/WebConsoleUtil.java
@@ -43,7 +43,10 @@ import
org.apache.commons.fileupload.servlet.ServletRequestContext;
/**
* The <code>WebConsoleUtil</code> provides various utility methods for use
* by Web Console plugins.
+ *
+ * @deprecated Some of the methods can be replaced with direct Servlet API
calls.
*/
+@Deprecated
public final class WebConsoleUtil
{
@@ -72,7 +75,7 @@ public final class WebConsoleUtil
* @param request The request whose attribute is returned (or set)
*
* @return The {@link VariableResolver} for the given request.
- * @deprecated Use the {@link getRequestVariableResolver} instead.
+ * @deprecated Use the {@link
org.apache.felix.webconsole.servlet.RequestVariableResolver} instead.
*/
@Deprecated
public static VariableResolver getVariableResolver( final ServletRequest
request ) {
@@ -96,7 +99,7 @@ public final class WebConsoleUtil
*
* @param request The request whose attribute is set
* @param resolver The {@link VariableResolver} to place into the request
- * @deprecated Use the {@link RequestVaraibleResolver} instead.
+ * @deprecated Use the {@link
org.apache.felix.webconsole.servlet.RequestVariableResolver} instead.
*/
@Deprecated
public static void setVariableResolver( final ServletRequest request,
final VariableResolver resolver ) {
@@ -322,7 +325,6 @@ public final class WebConsoleUtil
* @param value the value to decode
* @return the decoded string
*/
- @SuppressWarnings("deprecation")
public static String urlDecode( final String value )
{
// shortcut for empty or missing values
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/JakartaServletAdapter.java
b/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/JakartaServletAdapter.java
index fdcdc431f5..422b18533d 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/JakartaServletAdapter.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/JakartaServletAdapter.java
@@ -63,7 +63,6 @@ public class JakartaServletAdapter extends
AbstractWebConsolePlugin {
/**
* Creates a new wrapper for a Web Console Plugin
*
- * @param label the label
* @param plugin the plugin itself
* @param serviceReference reference to the plugin
*/
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/OsgiManager.java
b/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/OsgiManager.java
index f478a296c4..2c1001f381 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/OsgiManager.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/internal/servlet/OsgiManager.java
@@ -114,7 +114,7 @@ public class OsgiManager extends GenericServlet {
/**
* The name of the (internal) request attribute providing the categorized
* label map structure.
- * @deprecated use {@link WebConsoleConstants#ATTR_LABEL_MAP_CATEGORIZED}
instead
+ * @deprecated use {@link WebConsoleConstants#ATTR_LABEL_MAP} instead
*/
@Deprecated
public static final String ATTR_LABEL_MAP_CATEGORIZED =
WebConsoleConstants.ATTR_LABEL_MAP + ".categorized";
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/AbstractServlet.java
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/AbstractServlet.java
index 857f542864..429a66bc6d 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/AbstractServlet.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/AbstractServlet.java
@@ -108,7 +108,6 @@ public abstract class AbstractServlet extends HttpServlet {
*
* @param request The request object
* @param response The response object
- * @return <code>true</code> if the request causes a resource to be sent
back.
*
* @throws IOException If an error occurs accessing or spooling the
resource.
*/
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/RequestVariableResolver.java
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/RequestVariableResolver.java
index e80dd8fb75..39f64d6b23 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/RequestVariableResolver.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/RequestVariableResolver.java
@@ -38,14 +38,14 @@ public class RequestVariableResolver extends
HashMap<String, Object> {
/**
* The name of the key providing the absolute path of the Web Console root.
* This key is guaaranteed to be set for plugins.
- * @see ServletConstants.ATTR_APP_ROOT
+ * @see ServletConstants#ATTR_APP_ROOT
*/
public static final String KEY_APP_ROOT = "appRoot";
/**
* The name of the key providing the absolute path of the current plugin.
* This key is guaaranteed to be set for plugins.
- * @see ServletConstants.ATTR_PLUGIN_ROOT
+ * @see ServletConstants#ATTR_PLUGIN_ROOT
*/
public static final String KEY_PLUGIN_ROOT = "pluginRoot";
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/ServletConstants.java
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/ServletConstants.java
index 4a10889274..7f5e564a7c 100644
---
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/ServletConstants.java
+++
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/ServletConstants.java
@@ -39,7 +39,6 @@ public abstract class ServletConstants {
* <p>
* This property is required for the service to be used as a plugin.
* Otherwise the service is just ignored by the web console.
- * <p>
*/
public static final String PLUGIN_TITLE = "felix.webconsole.title";
diff --git
a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/User.java
b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/User.java
index cb7240a517..013d0e91d3 100644
--- a/webconsole/src/main/java/org/apache/felix/webconsole/servlet/User.java
+++ b/webconsole/src/main/java/org/apache/felix/webconsole/servlet/User.java
@@ -36,7 +36,6 @@ public interface User {
* Return the user object.
* This method might return {@code null} if no web console security
provider is configured and
* access to the console is allowed without authentication.
- * This is the same value as the request attribute from {@link
WebConsoleSecurityProvider2#USER_ATTRIBUTE}.
* @return The user object or {@code null}
*/
Object getUserObject();
