You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2025/01/02 12:36:05 UTC
(sling-org-apache-sling-api) branch jakarta-2 updated: Added more jakarta based interfaces
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch jakarta-2
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-api.git
The following commit(s) were added to refs/heads/jakarta-2 by this push:
new 09d4539 Added more jakarta based interfaces
09d4539 is described below
commit 09d4539683ecac68fb732e45c4f530c08addc554
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Thu Jan 2 13:35:58 2025 +0100
Added more jakarta based interfaces
---
JAKARTA.md | 15 +--
.../api/request/SlingJakartaRequestEvent.java | 1 +
.../api/request/SlingJakartaRequestListener.java | 1 +
.../api/request/header/JakartaMediaRangeList.java | 1 +
.../sling/api/request/header/package-info.java | 2 +-
.../api/scripting/ScriptEvaluationException.java | 2 +-
.../apache/sling/api/scripting/SlingBindings.java | 2 +
...lingBindings.java => SlingJakartaBindings.java} | 59 +++++-----
.../{SlingScript.java => SlingJakartaScript.java} | 21 ++--
...ptHelper.java => SlingJakartaScriptHelper.java} | 24 ++---
.../apache/sling/api/scripting/SlingScript.java | 2 +
.../sling/api/scripting/SlingScriptHelper.java | 2 +
.../apache/sling/api/scripting/package-info.java | 2 +-
.../apache/sling/api/servlets/ErrorHandler.java | 2 +
...{ErrorHandler.java => JakartaErrorHandler.java} | 17 +--
.../sling/api/servlets/SlingAllMethodsServlet.java | 2 +
...let.java => SlingJakartaAllMethodsServlet.java} | 39 +++----
...et.java => SlingJakartaSafeMethodsServlet.java} | 120 ++++++++++-----------
.../api/servlets/SlingSafeMethodsServlet.java | 2 +
.../wrappers/SlingHttpServletRequestWrapper.java | 3 +
.../wrappers/SlingHttpServletResponseWrapper.java | 2 +
... => SlingJakartaHttpServletRequestWrapper.java} | 25 ++---
...=> SlingJakartaHttpServletResponseWrapper.java} | 25 ++---
.../apache/sling/api/wrappers/package-info.java | 2 +-
24 files changed, 199 insertions(+), 174 deletions(-)
diff --git a/JAKARTA.md b/JAKARTA.md
index d61d22d..0bb6233 100644
--- a/JAKARTA.md
+++ b/JAKARTA.md
@@ -1,13 +1,6 @@
Open questions:
- org/apache/sling/api/SlingConstants.java: Deprecate as jakarta servlet api provides them (Dispatcher)?
-- org/apache/sling/api/scripting/SlingBindings.java: Needs new methods, name?
-- org/apache/sling/api/scripting/SlingScriptHelper.java: Needs new interface, name?
- org/apache/sling/api/servlets/OptingServlet.java: Should we deprecate this?
-- org/apache/sling/api/servlets/ErrorHandler.java: needs new interface, name?
-- org/apache/sling/api/servlets/SlingAllMethodsServlet.java: needs new class, name?
-- org/apache/sling/api/servlets/SlingSafeMethodsServlet.java: needs new class, name?
-- org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java: needs new class, name?
-- org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java: needs new class, name?
- org/apache/sling/api/wrappers/SlingRequestPaths.java: Constants can be deprecated, methods copied?
These files have been changed/copied:
@@ -24,9 +17,17 @@ These files have been changed/copied:
- org/apache/sling/api/request/header/MediaRangeList.java: new class org/apache/sling/api/http/MediaRangeList.java (Class)
- org/apache/sling/api/resource/ResourceResolver.java: added new methods: resolve, map (Provider Type)
- org/apache/sling/api/resource/mapping/ResourceMapper.java: added new methods: getMapping, getAllMappings (Provider Type)
+- org/apache/sling/api/scripting/SlingBindings.java: New class SlingJakartaBindings
+- org/apache/sling/api/scripting/SlingScript.java: New class SlingJakartaScript
+- org/apache/sling/api/scripting/SlingScriptHelper.java: New class SlingJakartaScriptHelper
+- org/apache/sling/api/servlets/ErrorHandler.java: added new interface JakartaErrorHandler (Consumer Type)
- org/apache/sling/api/servlets/ServletResolver.java: added new methods (Provider Type)
+- org/apache/sling/api/servlets/SlingAllMethodsServlet.java: added new class SlingJakartaAllMethodsServlet
+- org/apache/sling/api/servlets/SlingSafeMethodsServlet.java: added new class SlingJakartaSafeMethodsServlet
- org/apache/sling/api/uri/SlingUriBuilder.java: added new method: createFrom (Class)
- org/apache/sling/api/wrappers/ResourceResolverWrapper.java: added new methods from ResourceResolver (Class)
+- org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java: new class SlingJakartaHttpServletRequestWrapper
+- org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java: new class SlingJakartaHttpServletResponseWrapper
These files contain references to javax.servlet, but do not require an alternative:
- org/apache/sling/api/auth/NoAuthenticationHandlerException.java: only used in javadoc
diff --git a/src/main/java/org/apache/sling/api/request/SlingJakartaRequestEvent.java b/src/main/java/org/apache/sling/api/request/SlingJakartaRequestEvent.java
index 5f6fff9..ef2fd5c 100644
--- a/src/main/java/org/apache/sling/api/request/SlingJakartaRequestEvent.java
+++ b/src/main/java/org/apache/sling/api/request/SlingJakartaRequestEvent.java
@@ -28,6 +28,7 @@ import jakarta.servlet.ServletRequest;
* <p>
* This class is not intended to be extended or instantiated by clients.
*
+ * @since 2.8.0
* @see org.apache.sling.api.request.SlingJakartaRequestListener
*/
public class SlingJakartaRequestEvent {
diff --git a/src/main/java/org/apache/sling/api/request/SlingJakartaRequestListener.java b/src/main/java/org/apache/sling/api/request/SlingJakartaRequestListener.java
index 3b93af7..4bc6cd3 100644
--- a/src/main/java/org/apache/sling/api/request/SlingJakartaRequestListener.java
+++ b/src/main/java/org/apache/sling/api/request/SlingJakartaRequestListener.java
@@ -27,6 +27,7 @@ import org.osgi.annotation.versioning.ConsumerType;
* To receive notification events, the implementation class must be
* registered as an OSGi service with the service name
* org.apache.sling.api.request.event.SlingRequestListener.
+ * @since 2.8.0
*/
@ConsumerType
public interface SlingJakartaRequestListener {
diff --git a/src/main/java/org/apache/sling/api/request/header/JakartaMediaRangeList.java b/src/main/java/org/apache/sling/api/request/header/JakartaMediaRangeList.java
index a28d905..80b70cd 100644
--- a/src/main/java/org/apache/sling/api/request/header/JakartaMediaRangeList.java
+++ b/src/main/java/org/apache/sling/api/request/header/JakartaMediaRangeList.java
@@ -31,6 +31,7 @@ import org.slf4j.LoggerFactory;
/**
* Facilitates parsing of the Accept HTTP request header.
* See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC 2616 section 14.1</a>
+ * @since 1.1.0
*/
@ConsumerType
public class JakartaMediaRangeList extends TreeSet<JakartaMediaRangeList.MediaRange> {
diff --git a/src/main/java/org/apache/sling/api/request/header/package-info.java b/src/main/java/org/apache/sling/api/request/header/package-info.java
index 386b026..a7085e2 100644
--- a/src/main/java/org/apache/sling/api/request/header/package-info.java
+++ b/src/main/java/org/apache/sling/api/request/header/package-info.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-@Version("1.0.0")
+@Version("1.1.0")
package org.apache.sling.api.request.header;
import org.osgi.annotation.versioning.Version;
diff --git a/src/main/java/org/apache/sling/api/scripting/ScriptEvaluationException.java b/src/main/java/org/apache/sling/api/scripting/ScriptEvaluationException.java
index 753882b..7c8ace7 100644
--- a/src/main/java/org/apache/sling/api/scripting/ScriptEvaluationException.java
+++ b/src/main/java/org/apache/sling/api/scripting/ScriptEvaluationException.java
@@ -22,7 +22,7 @@ import org.apache.sling.api.SlingException;
/**
* The <code>ScriptEvaluationException</code> is thrown by the
- * {@link SlingScript#eval(SlingBindings)} method if an error occurrs evaluating
+ * {@link SlingJakartaScript#eval(SlingJakartaBindings)} method if an error occurrs evaluating
* the script.
*/
public class ScriptEvaluationException extends SlingException {
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java b/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
index bdc32f7..154c8f9 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
@@ -33,7 +33,9 @@ import org.slf4j.Logger;
* for script execution. The constants in this class define names of variables
* which <em>MUST</em> or <em>MAY</em> be provided for the script execution.
* Other variables may be define as callers see fit.
+ * @deprecated Use {@link SlingJakartaBindings} instead.
*/
+@Deprecated
public class SlingBindings extends LazyBindings {
private static final long serialVersionUID = 209505693646323450L;
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java b/src/main/java/org/apache/sling/api/scripting/SlingJakartaBindings.java
similarity index 84%
copy from src/main/java/org/apache/sling/api/scripting/SlingBindings.java
copy to src/main/java/org/apache/sling/api/scripting/SlingJakartaBindings.java
index bdc32f7..6cd721b 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingJakartaBindings.java
@@ -21,29 +21,28 @@ package org.apache.sling.api.scripting;
import java.io.PrintWriter;
import java.io.Reader;
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
/**
- * The <code>SlingBindings</code> class is used to prepare global variables
+ * The <code>SlingJakartaBindings</code> class is used to prepare global variables
* for script execution. The constants in this class define names of variables
* which <em>MUST</em> or <em>MAY</em> be provided for the script execution.
* Other variables may be define as callers see fit.
+ * @since 2.6.0
*/
-public class SlingBindings extends LazyBindings {
+public class SlingJakartaBindings extends LazyBindings {
- private static final long serialVersionUID = 209505693646323450L;
-
- /**
+ /**
* The name of the global scripting variable providing the
- * {@link org.apache.sling.api.SlingHttpServletRequest} object (value is
+ * {@link org.apache.sling.api.SlingJakartaHttpServletRequest} object (value is
* "request"). The value of the scripting variable is the same as that
* returned by the
- * {@link org.apache.sling.api.scripting.SlingScriptHelper#getRequest()}
+ * {@link org.apache.sling.api.scripting.SlingJakartaScriptHelper#getRequest()}
* method.
* <p>
* This bound variable is required in the bindings given the script.
@@ -52,10 +51,10 @@ public class SlingBindings extends LazyBindings {
/**
* The name of the global scripting variable providing the
- * {@link org.apache.sling.api.SlingHttpServletResponse} object (value is
+ * {@link org.apache.sling.api.SlingJakartaHttpServletResponse} object (value is
* "response"). The value of the scripting variable is the same as that
* returned by the
- * {@link org.apache.sling.api.scripting.SlingScriptHelper#getResponse()}
+ * {@link org.apache.sling.api.scripting.SlingJakartaScriptHelper#getResponse()}
* method.
* <p>
* This bound variable is required in the bindings given the script.
@@ -72,7 +71,7 @@ public class SlingBindings extends LazyBindings {
/**
* The name of the global scripting variable providing the
- * {@link org.apache.sling.api.scripting.SlingScriptHelper} for the request
+ * {@link org.apache.sling.api.scripting.SlingJakartaScriptHelper} for the request
* (value is "sling").
* <p>
* This bound variable is optional. If existing, the script helper instance
@@ -87,12 +86,12 @@ public class SlingBindings extends LazyBindings {
* The name of the global scripting variable providing the
* {@link org.apache.sling.api.resource.Resource} object (value is
* "resource"). The value of the scripting variable is the same as that
- * returned by the <code>SlingScriptHelper.getRequest().getResource()</code>
+ * returned by the <code>SlingJakartaScriptHelper.getRequest().getResource()</code>
* method.
* <p>
* This bound variable is optional. If existing, the resource must be bound
* to the same resource as returned by the
- * <code>SlingHttpServletRequest.getResource()</code> method. If this
+ * <code>SlingJakartaHttpServletRequest.getResource()</code> method. If this
* variable is not bound, the script implementation will bind it before
* actually evaluating the script.
*/
@@ -103,13 +102,13 @@ public class SlingBindings extends LazyBindings {
* The name of the global scripting variable providing the
* {@link org.apache.sling.api.resource.ResourceResolver} object (value is
* "resolver"). The value of the scripting variable is the same as that
- * returned by the {@code SlingScriptHelper.getRequest().getResourceResolver()}
+ * returned by the {@code SlingJakartaScriptHelper.getRequest().getResourceResolver()}
* method.
* </p>
* <p>
* This bound variable is optional. If existing, the resource resolver must be
* bound to the same resolver as returned by the {@code
- * SlingHttpServletRequest.getResource().getResourceResolver} method. If this
+ * SlingJakartaHttpServletRequest.getResource().getResourceResolver} method. If this
* variable is not bound, the script implementation will bind it before actually
* evaluating the script.
* </p>
@@ -120,7 +119,7 @@ public class SlingBindings extends LazyBindings {
* The name of the global scripting variable providing the
* <code>java.io.PrintWriter</code> object to return the response content
* (value is "out"). The value of the scripting variable is the same as that
- * returned by the <code>SlingScriptHelper.getResponse().getWriter()</code>
+ * returned by the <code>SlingJakartaScriptHelper.getResponse().getWriter()</code>
* method.
* <p>
* Note, that it may be advisable to implement a lazy acquiring writer for
@@ -129,7 +128,7 @@ public class SlingBindings extends LazyBindings {
* <p>
* This bound variable is optional. If existing, the resource must be bound
* to the same writer as returned by the
- * <code>SlingHttpServletResponse.getWriter()</code> method of the
+ * <code>SlingJakartaHttpServletResponse.getWriter()</code> method of the
* response object bound to the {@link #RESPONSE} variable. If this variable
* is not bound, the script implementation will bind it before actually
* evaluating the script.
@@ -251,18 +250,18 @@ public class SlingBindings extends LazyBindings {
* <code>null</code>.
* @param request The request object.
*/
- public void setRequest(SlingHttpServletRequest request) {
+ public void setRequest(SlingJakartaHttpServletRequest request) {
this.safePut(REQUEST, request);
}
/**
* Returns the {@link #REQUEST} property if not <code>null</code> and a
- * <code>SlingHttpServletRequest</code> instance. Otherwise
+ * <code>SlingJakartaHttpServletRequest</code> instance. Otherwise
* <code>null</code> is returned.
* @return The request object or {@code null}
*/
- public @Nullable SlingHttpServletRequest getRequest() {
- return this.get(REQUEST, SlingHttpServletRequest.class);
+ public @Nullable SlingJakartaHttpServletRequest getRequest() {
+ return this.get(REQUEST, SlingJakartaHttpServletRequest.class);
}
/**
@@ -326,18 +325,18 @@ public class SlingBindings extends LazyBindings {
* <code>null</code>.
* @param response The response
*/
- public void setResponse(SlingHttpServletResponse response) {
+ public void setResponse(SlingJakartaHttpServletResponse response) {
this.safePut(RESPONSE, response);
}
/**
* Returns the {@link #RESPONSE} property if not <code>null</code> and a
- * <code>SlingHttpServletResponse</code> instance. Otherwise
+ * <code>SlingJakartaHttpServletResponse</code> instance. Otherwise
* <code>null</code> is returned.
* @return The response or {@code null}.
*/
- public @Nullable SlingHttpServletResponse getResponse() {
- return this.get(RESPONSE, SlingHttpServletResponse.class);
+ public @Nullable SlingJakartaHttpServletResponse getResponse() {
+ return this.get(RESPONSE, SlingJakartaHttpServletResponse.class);
}
/**
@@ -345,17 +344,17 @@ public class SlingBindings extends LazyBindings {
* <code>null</code>.
* @param sling The script helper
*/
- public void setSling(SlingScriptHelper sling) {
+ public void setSling(SlingJakartaScriptHelper sling) {
this.safePut(SLING, sling);
}
/**
* Returns the {@link #SLING} property if not <code>null</code> and a
- * <code>SlingScriptHelper</code> instance. Otherwise <code>null</code>
+ * <code>SlingJakartaScriptHelper</code> instance. Otherwise <code>null</code>
* is returned.
* @return The script helper or {@code null}.
*/
- public @Nullable SlingScriptHelper getSling() {
- return this.get(SLING, SlingScriptHelper.class);
+ public @Nullable SlingJakartaScriptHelper getSling() {
+ return this.get(SLING, SlingJakartaScriptHelper.class);
}
}
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingScript.java b/src/main/java/org/apache/sling/api/scripting/SlingJakartaScript.java
similarity index 77%
copy from src/main/java/org/apache/sling/api/scripting/SlingScript.java
copy to src/main/java/org/apache/sling/api/scripting/SlingJakartaScript.java
index 08a7041..880e37e 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingScript.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingJakartaScript.java
@@ -25,18 +25,19 @@ import org.apache.sling.api.resource.Resource;
import org.osgi.annotation.versioning.ConsumerType;
/**
- * The <code>SlingScript</code> defines the API for objects which encapsulate
- * a script. To evaluate a script prepare a {@link SlingBindings} instance of
+ * The <code>SlingJakartaScript</code> defines the API for objects which encapsulate
+ * a script. To evaluate a script prepare a {@link SlingJakartaBindings} instance of
* variables used as global variables to the script and call the
- * {@link #eval(SlingBindings)} method.
+ * {@link #eval(SlingJakartaBindings)} method.
* <p>
* You can obtain scripts by resolving a script resource through
* {@link org.apache.sling.api.resource.ResourceResolver#resolve(String)}
* and then trying to adapt the resource to a script by
* calling {@link Resource#adaptTo(Class)}.
+ * @since 2.6.0
*/
@ConsumerType
-public interface SlingScript {
+public interface SlingJakartaScript {
/**
* Returns the Resource providing the script source code.
@@ -48,24 +49,24 @@ public interface SlingScript {
* Evaluates this script using the bound variables as global variables to
* the script.
*
- * @param props The {@link SlingBindings} providing the bound variables for
+ * @param props The {@link SlingJakartaBindings} providing the bound variables for
* evaluating the script. Any bound variables must conform to the
- * requirements of the {@link SlingBindings} predefined variables
+ * requirements of the {@link SlingJakartaBindings} predefined variables
* set.
* @return The value returned by the script.
* @throws ScriptEvaluationException If an error occurs executing the
* script or preparing the script execution. The cause of the
* evaluation exception is available as the exception cause.
*/
- Object eval(@NotNull SlingBindings props);
+ Object eval(@NotNull SlingJakartaBindings props);
/**
* Evaluates this script using the bound variables as global variables to
* the script and then calls the given method with the arguments.
*
- * @param props The {@link SlingBindings} providing the bound variables for
+ * @param props The {@link SlingJakartaBindings} providing the bound variables for
* evaluating the script. Any bound variables must conform to the
- * requirements of the {@link SlingBindings} predefined variables
+ * requirements of the {@link SlingJakartaBindings} predefined variables
* set.
* @param method The name of the method to call.
* @param args The arguments for the method call.
@@ -74,5 +75,5 @@ public interface SlingScript {
* script or preparing the script execution. The cause of the
* evaluation exception is available as the exception cause.
*/
- Object call(@NotNull SlingBindings props, @NotNull String method, Object... args);
+ Object call(@NotNull SlingJakartaBindings props, @NotNull String method, Object... args);
}
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java b/src/main/java/org/apache/sling/api/scripting/SlingJakartaScriptHelper.java
similarity index 95%
copy from src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
copy to src/main/java/org/apache/sling/api/scripting/SlingJakartaScriptHelper.java
index 98b1ef7..1545dc7 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingJakartaScriptHelper.java
@@ -20,41 +20,41 @@ package org.apache.sling.api.scripting;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.NotNull;
-
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
import org.apache.sling.api.request.RequestDispatcherOptions;
import org.apache.sling.api.resource.Resource;
import org.osgi.annotation.versioning.ProviderType;
/**
- * The <code>SlingScriptHelper</code> interface defines the API of a helper
+ * The <code>SlingJakartaScriptHelper</code> interface defines the API of a helper
* class which is provided to the scripts called from sling through the global
- * <code>{@link SlingBindings#SLING sling}</code> variable.
+ * <code>{@link SlingJakartaBindings#SLING sling}</code> variable.
+ * @since 2.6.0
*/
@ProviderType
-public interface SlingScriptHelper {
+public interface SlingJakartaScriptHelper {
/**
- * Returns the {@link SlingHttpServletRequest} representing the input of the
+ * Returns the {@link SlingJakartaHttpServletRequest} representing the input of the
* request.
* @return The request
*/
- @NotNull SlingHttpServletRequest getRequest();
+ @NotNull SlingJakartaHttpServletRequest getRequest();
/**
- * Returns the {@link SlingHttpServletResponse} representing the output of
+ * Returns the {@link SlingJakartaHttpServletResponse} representing the output of
* the request.
* @return The response
*/
- @NotNull SlingHttpServletResponse getResponse();
+ @NotNull SlingJakartaHttpServletResponse getResponse();
/**
- * Returns the {@link SlingScript} being called to handle the request.
+ * Returns the {@link SlingJakartaScriptHelper} being called to handle the request.
* @return The script
*/
- @NotNull SlingScript getScript();
+ @NotNull SlingJakartaScript getScript();
/**
* Same as {@link #include(String,RequestDispatcherOptions)}, but using
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingScript.java b/src/main/java/org/apache/sling/api/scripting/SlingScript.java
index 08a7041..a708dd9 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingScript.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingScript.java
@@ -34,7 +34,9 @@ import org.osgi.annotation.versioning.ConsumerType;
* {@link org.apache.sling.api.resource.ResourceResolver#resolve(String)}
* and then trying to adapt the resource to a script by
* calling {@link Resource#adaptTo(Class)}.
+ * @deprecated Use {@link SlingJakartaScript} instead
*/
+@Deprecated
@ConsumerType
public interface SlingScript {
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java b/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
index 98b1ef7..08191b9 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
@@ -32,7 +32,9 @@ import org.osgi.annotation.versioning.ProviderType;
* The <code>SlingScriptHelper</code> interface defines the API of a helper
* class which is provided to the scripts called from sling through the global
* <code>{@link SlingBindings#SLING sling}</code> variable.
+ * @deprecated Use {@link SlingJakartaBindings} instead.
*/
+@Deprecated
@ProviderType
public interface SlingScriptHelper {
diff --git a/src/main/java/org/apache/sling/api/scripting/package-info.java b/src/main/java/org/apache/sling/api/scripting/package-info.java
index e43eb81..1772977 100644
--- a/src/main/java/org/apache/sling/api/scripting/package-info.java
+++ b/src/main/java/org/apache/sling/api/scripting/package-info.java
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("2.5.0")
+@Version("2.6.0")
package org.apache.sling.api.scripting;
import org.osgi.annotation.versioning.Version;
diff --git a/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java b/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java
index c448739..a8dcf7e 100644
--- a/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java
+++ b/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java
@@ -28,7 +28,9 @@ import org.osgi.annotation.versioning.ConsumerType;
* The <code>ErrorHandler</code> defines the interface of the service used by
* the Sling to handle calls to <code>HttpServletResponse.sendError</code> and
* to handle uncaught <code>Throwable</code>s.
+ * @deprecated Use {@link JakartaErrorHandler} instead.
*/
+@Deprecated
@ConsumerType
public interface ErrorHandler {
diff --git a/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java b/src/main/java/org/apache/sling/api/servlets/JakartaErrorHandler.java
similarity index 80%
copy from src/main/java/org/apache/sling/api/servlets/ErrorHandler.java
copy to src/main/java/org/apache/sling/api/servlets/JakartaErrorHandler.java
index c448739..cfdf3f6 100644
--- a/src/main/java/org/apache/sling/api/servlets/ErrorHandler.java
+++ b/src/main/java/org/apache/sling/api/servlets/JakartaErrorHandler.java
@@ -20,17 +20,18 @@ package org.apache.sling.api.servlets;
import java.io.IOException;
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
import org.osgi.annotation.versioning.ConsumerType;
/**
- * The <code>ErrorHandler</code> defines the interface of the service used by
- * the Sling to handle calls to <code>HttpServletResponse.sendError</code> and
+ * The <code>JakartaErrorHandler</code> defines the interface of the service used by
+ * the Sling to handle calls to <code>jakarta.servlet.http.HttpServletResponse.sendError</code> and
* to handle uncaught <code>Throwable</code>s.
+ * @since 2.5
*/
@ConsumerType
-public interface ErrorHandler {
+public interface JakartaErrorHandler {
/**
* Called to render a response for a HTTP status code. This method should
@@ -49,7 +50,7 @@ public interface ErrorHandler {
* response.
*/
void handleError(int status, String message,
- SlingHttpServletRequest request, SlingHttpServletResponse response)
+ SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response)
throws IOException;
/**
@@ -66,7 +67,7 @@ public interface ErrorHandler {
* @throws IOException May be thrown if an error occurrs sending the
* response.
*/
- void handleError(Throwable throwable, SlingHttpServletRequest request,
- SlingHttpServletResponse response) throws IOException;
+ void handleError(Throwable throwable, SlingJakartaHttpServletResponse request,
+ SlingJakartaHttpServletRequest response) throws IOException;
}
diff --git a/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java b/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
index 7666fe9..e6ba8f0 100644
--- a/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
+++ b/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
@@ -38,7 +38,9 @@ import org.apache.sling.api.SlingHttpServletResponse;
*
* @see SlingSafeMethodsServlet for more information on supporting more HTTP
* methods
+ * @deprecated Use {@link SlingJakartaAllMethodsServlet} instead
*/
+@Deprecated
public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
private static final long serialVersionUID = -7960975481323952419L;
diff --git a/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java b/src/main/java/org/apache/sling/api/servlets/SlingJakartaAllMethodsServlet.java
similarity index 82%
copy from src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
copy to src/main/java/org/apache/sling/api/servlets/SlingJakartaAllMethodsServlet.java
index 7666fe9..56268eb 100644
--- a/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
+++ b/src/main/java/org/apache/sling/api/servlets/SlingJakartaAllMethodsServlet.java
@@ -21,14 +21,14 @@ import java.lang.reflect.Method;
import java.util.Map;
import org.jetbrains.annotations.NotNull;
-import javax.servlet.ServletException;
+import jakarta.servlet.ServletException;
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
/**
* Helper base class for data modifying Servlets used in Sling. This class
- * extends the {@link SlingSafeMethodsServlet} by support for the <em>POST</em>,
+ * extends the {@link SlingJakartaSafeMethodsServlet} by support for the <em>POST</em>,
* <em>PUT</em> and <em>DELETE</em> methods.
* <p>
* Implementors note: The methods in this class are all declared to throw the
@@ -36,16 +36,17 @@ import org.apache.sling.api.SlingHttpServletResponse;
* throwing their Sling RuntimeException counter parts. This is done to easy the
* integration with traditional servlets.
*
- * @see SlingSafeMethodsServlet for more information on supporting more HTTP
+ * @since 2.5.0
+ * @see SlingJakartaSafeMethodsServlet for more information on supporting more HTTP
* methods
*/
-public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
+public class SlingJakartaAllMethodsServlet extends SlingJakartaSafeMethodsServlet {
private static final long serialVersionUID = -7960975481323952419L;
/**
* Called by the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method to
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method to
* handle an HTTP <em>POST</em> request.
* <p>
* This default implementation reports back to the client that the method is
@@ -60,15 +61,15 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
* @throws IOException If the error status cannot be reported back to the
* client.
*/
- protected void doPost(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doPost(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
handleMethodNotImplemented(request, response);
}
/**
* Called by the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method to
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method to
* handle an HTTP <em>PUT</em> request.
* <p>
* This default implementation reports back to the client that the method is
@@ -83,15 +84,15 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
* @throws IOException If the error status cannot be reported back to the
* client.
*/
- protected void doPut(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doPut(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
handleMethodNotImplemented(request, response);
}
/**
* Called by the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method to
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method to
* handle an HTTP <em>DELETE</em> request.
* <p>
* This default implementation reports back to the client that the method is
@@ -106,8 +107,8 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
* @throws IOException If the error status cannot be reported back to the
* client.
*/
- protected void doDelete(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doDelete(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
handleMethodNotImplemented(request, response);
}
@@ -129,8 +130,8 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
* @throws ServletException Forwarded from any of the dispatched methods
* @throws IOException Forwarded from any of the dispatched methods
*/
- protected boolean mayService(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected boolean mayService(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
// assume the method is known for now
@@ -159,7 +160,7 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
/**
* Helper method called by
- * {@link #doOptions(SlingHttpServletRequest, SlingHttpServletResponse)} to calculate
+ * {@link #doOptions(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} to calculate
* the value of the <em>Allow</em> header sent as the response to the HTTP
* <em>OPTIONS</em> request.
* <p>
@@ -178,7 +179,7 @@ public class SlingAllMethodsServlet extends SlingSafeMethodsServlet {
StringBuffer allowBuf = super.getAllowedRequestMethods(declaredMethods);
// add more method names depending on the methods found
- String className = SlingAllMethodsServlet.class.getName();
+ String className = SlingJakartaAllMethodsServlet.class.getName();
if (isMethodValid(declaredMethods.get("doPost"), className)) {
allowBuf.append(", ").append(HttpConstants.METHOD_POST);
diff --git a/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java b/src/main/java/org/apache/sling/api/servlets/SlingJakartaSafeMethodsServlet.java
similarity index 80%
copy from src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
copy to src/main/java/org/apache/sling/api/servlets/SlingJakartaSafeMethodsServlet.java
index 1d25ce9..14a0380 100644
--- a/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
+++ b/src/main/java/org/apache/sling/api/servlets/SlingJakartaSafeMethodsServlet.java
@@ -26,18 +26,18 @@ import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
+import org.apache.sling.api.wrappers.SlingJakartaHttpServletResponseWrapper;
import org.jetbrains.annotations.NotNull;
-import javax.servlet.GenericServlet;
-import javax.servlet.ServletException;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.WriteListener;
-import javax.servlet.http.HttpServletResponse;
-
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.SlingHttpServletResponse;
-import org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper;
+import jakarta.servlet.GenericServlet;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletOutputStream;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.WriteListener;
+import jakarta.servlet.http.HttpServletResponse;
+
/**
* Helper base class for read-only Servlets used in Sling. This base class is
@@ -48,7 +48,7 @@ import org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper;
* If any of the default HTTP methods is to be implemented just overwrite the
* respective doXXX method. If additional methods should be supported implement
* appropriate doXXX methods and overwrite the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method
* to dispatch to the doXXX methods as appropriate and overwrite the
* {@link #getAllowedRequestMethods(Map)} to add the new method names.
* <p>
@@ -57,7 +57,7 @@ import org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper;
* <em>PUT</em> and <em>DELETE</em> methods. Extensions of this class should
* either overwrite any of the doXXX methods of this class or add support for
* other read-only methods only. Applications wishing to support data
- * modification should rather use or extend the {@link SlingAllMethodsServlet}
+ * modification should rather use or extend the {@link SlingJakartaAllMethodsServlet}
* which also contains support for the <em>POST</em>, <em>PUT</em> and
* <em>DELETE</em> methods. This latter class should also be overwritten to
* add support for HTTP methods modifying data.
@@ -67,9 +67,10 @@ import org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper;
* throwing their Sling RuntimeException counter parts. This is done to ease the
* integration with traditional servlets.
*
- * @see SlingAllMethodsServlet
+ * @since 2.5.0
+ * @see SlingJakartaAllMethodsServlet
*/
-public class SlingSafeMethodsServlet extends GenericServlet {
+public class SlingJakartaSafeMethodsServlet extends GenericServlet {
private static final long serialVersionUID = 3620512288346703072L;
@@ -77,7 +78,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* Handles the <em>HEAD</em> method.
* <p>
* This base implementation just calls the
- * {@link #doGet(SlingHttpServletRequest, SlingHttpServletResponse)} method dropping
+ * {@link #doGet(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method dropping
* the output. Implementations of this class may overwrite this method if
* they have a more performing implementation. Otherwise, they may just keep
* this base implementation.
@@ -85,14 +86,14 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @param request The HTTP request
* @param response The HTTP response which only gets the headers set
* @throws ServletException Forwarded from the
- * {@link #doGet(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #doGet(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* method called by this implementation.
* @throws IOException Forwarded from the
- * {@link #doGet(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #doGet(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* method called by this implementation.
*/
- protected void doHead(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doHead(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
// the null-output wrapper
@@ -107,7 +108,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/**
* Called by the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method to
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method to
* handle an HTTP <em>GET</em> request.
* <p>
* This default implementation reports back to the client that the method is
@@ -122,8 +123,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @throws IOException If the error status cannot be reported back to the
* client.
*/
- protected void doGet(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doGet(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
handleMethodNotImplemented(request, response);
}
@@ -146,8 +147,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @throws ServletException Not thrown by this implementation.
* @throws IOException Not thrown by this implementation.
*/
- protected void doOptions(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doOptions(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
Map<String, Method> methods = getAllDeclaredMethods(getClass());
StringBuffer allowBuf = getAllowedRequestMethods(methods);
@@ -168,8 +169,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @throws IOException May be thrown if there is an problem sending back the
* request headers in the response stream.
*/
- protected void doTrace(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doTrace(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
String CRLF = "\r\n";
@@ -205,7 +206,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
}
/**
- * Called by the {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * Called by the {@link #service(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* method to handle a request for an HTTP method, which is not known and
* handled by this class or its extension.
* <p>
@@ -214,7 +215,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* <p>
* This method should be overwritten with great care. It is better to
* overwrite the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method and
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method and
* add support for any extension HTTP methods through an additional doXXX
* method.
*
@@ -224,8 +225,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @throws IOException If the error status cannot be reported back to the
* client.
*/
- protected void doGeneric(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void doGeneric(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
handleMethodNotImplemented(request, response);
}
@@ -252,8 +253,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @throws ServletException Forwarded from any of the dispatched methods
* @throws IOException Forwarded from any of the dispatched methods
*/
- protected boolean mayService(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected boolean mayService(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
// assume the method is known for now
@@ -288,8 +289,8 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @param response The HTTP response to which the error status is sent.
* @throws IOException Thrown if the status cannot be sent to the client.
*/
- protected void handleMethodNotImplemented(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws IOException {
+ protected void handleMethodNotImplemented(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws IOException {
String protocol = request.getProtocol();
String msg = "Method " + request.getMethod() + " not supported";
@@ -309,33 +310,33 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/**
* Called by the {@link #service(ServletRequest, ServletResponse)} method to
* handle the HTTP request. This implementation calls the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method and
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method and
* depedending on its return value call the
- * {@link #doGeneric(SlingHttpServletRequest, SlingHttpServletResponse)} method. If
- * the {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method
+ * {@link #doGeneric(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method. If
+ * the {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method
* can handle the request, the
- * {@link #doGeneric(SlingHttpServletRequest, SlingHttpServletResponse)} method is not
+ * {@link #doGeneric(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method is not
* called otherwise it is called.
* <p>
* Implementations of this class should not generally overwrite this method.
- * Rather the {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * Rather the {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* method should be overwritten to add support for more HTTP methods.
*
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Forwarded from the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* or
- * {@link #doGeneric(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #doGeneric(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* methods.
* @throws IOException Forwarded from the
- * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* or
- * {@link #doGeneric(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #doGeneric(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* methods.
*/
- protected void service(@NotNull SlingHttpServletRequest request,
- @NotNull SlingHttpServletResponse response) throws ServletException,
+ protected void service(@NotNull SlingJakartaHttpServletRequest request,
+ @NotNull SlingJakartaHttpServletResponse response) throws ServletException,
IOException {
// first try to handle the request by the known methods
@@ -349,7 +350,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/**
* Forwards the request to the
- * {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #service(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* method if the request is a HTTP request.
* <p>
* Implementations of this class will not generally overwrite this method.
@@ -358,21 +359,21 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* @param res The Servlet response
* @throws ServletException If the request is not a HTTP request or
* forwarded from the
- * {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #service(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* called.
* @throws IOException Forwarded from the
- * {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link #service(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)}
* called.
*/
@Override
public void service(@NotNull ServletRequest req, @NotNull ServletResponse res)
throws ServletException, IOException {
- if ((req instanceof SlingHttpServletRequest)
- && (res instanceof SlingHttpServletResponse)) {
+ if ((req instanceof SlingJakartaHttpServletRequest)
+ && (res instanceof SlingJakartaHttpServletResponse)) {
- service((SlingHttpServletRequest) req,
- (SlingHttpServletResponse) res);
+ service((SlingJakartaHttpServletRequest) req,
+ (SlingJakartaHttpServletResponse) res);
} else {
@@ -392,7 +393,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/**
* Helper method called by
- * {@link #doOptions(SlingHttpServletRequest, SlingHttpServletResponse)} to calculate
+ * {@link #doOptions(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} to calculate
* the value of the <em>Allow</em> header sent as the response to the HTTP
* <em>OPTIONS</em> request.
* <p>
@@ -403,7 +404,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* <p>
* Implementations of this class may overwrite this method check for more
* methods supported by the extension (generally the same list as used in
- * the {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method).
+ * the {@link #mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method).
* This base class implementation should always be called to make sure the
* default HTTP methods are included in the list.
*
@@ -437,7 +438,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/**
* Returns a map of methods declared by the class indexed by method name.
* This method is called by the
- * {@link #doOptions(SlingHttpServletRequest, SlingHttpServletResponse)} method to
+ * {@link #doOptions(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)} method to
* find the methods to be checked by the
* {@link #getAllowedRequestMethods(Map)} method. Note, that only extension
* classes of this class are considered to be sure to not account for the
@@ -449,7 +450,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
private Map<String, Method> getAllDeclaredMethods(Class<?> c) {
// stop (and do not include) the AbstractSlingServletClass
if (c == null
- || c.getName().equals(SlingSafeMethodsServlet.class.getName())) {
+ || c.getName().equals(SlingJakartaSafeMethodsServlet.class.getName())) {
return new HashMap<String, Method>();
}
@@ -474,7 +475,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
* just swallows that body, counting the bytes in order to set the content
* length appropriately.
*/
- private class NoBodyResponse extends SlingHttpServletResponseWrapper {
+ private class NoBodyResponse extends SlingJakartaHttpServletResponseWrapper {
/** The byte sink and counter */
private NoBodyOutputStream noBody;
@@ -485,7 +486,7 @@ public class SlingSafeMethodsServlet extends GenericServlet {
/** Whether the request processor set the content length itself or not. */
private boolean didSetContentLength;
- NoBodyResponse(SlingHttpServletResponse wrappedResponse) {
+ NoBodyResponse(SlingJakartaHttpServletResponse wrappedResponse) {
super(wrappedResponse);
noBody = new NoBodyOutputStream();
}
@@ -576,5 +577,4 @@ public class SlingSafeMethodsServlet extends GenericServlet {
// nothing to do
}
}
-
}
diff --git a/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java b/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
index 1d25ce9..e8f8e38 100644
--- a/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
+++ b/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
@@ -68,7 +68,9 @@ import org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper;
* integration with traditional servlets.
*
* @see SlingAllMethodsServlet
+ * @deprecated Use {@link SlingJakartaSafeMethodsServlet} instead
*/
+@Deprecated
public class SlingSafeMethodsServlet extends GenericServlet {
private static final long serialVersionUID = 3620512288346703072L;
diff --git a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java b/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java
index a5402c6..623fbaf 100644
--- a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java
+++ b/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java
@@ -28,6 +28,7 @@ import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequestWrapper;
import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
import org.apache.sling.api.request.RequestDispatcherOptions;
import org.apache.sling.api.request.RequestParameter;
import org.apache.sling.api.request.RequestParameterMap;
@@ -40,7 +41,9 @@ import org.apache.sling.api.resource.ResourceResolver;
* The <code>SlingHttpServletRequestWrapper</code> class is a default wrapper
* class around a {@link SlingHttpServletRequest} which may be extended to amend
* the functionality of the original request object.
+ * @deprecated Use {@link SlingJakartaHttpServletRequest}
*/
+@Deprecated
public class SlingHttpServletRequestWrapper extends HttpServletRequestWrapper
implements SlingHttpServletRequest {
diff --git a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java b/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java
index 317e293..df16f40 100644
--- a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java
+++ b/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java
@@ -30,7 +30,9 @@ import org.apache.sling.api.SlingHttpServletResponse;
* There's nothing interesting to wrap currently, as the SlingHttpServletResponse
* interface is empty.
* So this exists only for symmetry with {@link SlingHttpServletRequestWrapper}
+ * @deprecated Use {@link SlingJakartaHttpServletResponseWrapper}
*/
+@Deprecated
public class SlingHttpServletResponseWrapper extends HttpServletResponseWrapper
implements SlingHttpServletResponse {
diff --git a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java b/src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletRequestWrapper.java
similarity index 83%
copy from src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java
copy to src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletRequestWrapper.java
index a5402c6..5a56e26 100644
--- a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.java
+++ b/src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletRequestWrapper.java
@@ -23,11 +23,11 @@ import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.http.Cookie;
-import javax.servlet.http.HttpServletRequestWrapper;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpServletRequestWrapper;
-import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.SlingJakartaHttpServletRequest;
import org.apache.sling.api.request.RequestDispatcherOptions;
import org.apache.sling.api.request.RequestParameter;
import org.apache.sling.api.request.RequestParameterMap;
@@ -37,28 +37,29 @@ import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
/**
- * The <code>SlingHttpServletRequestWrapper</code> class is a default wrapper
- * class around a {@link SlingHttpServletRequest} which may be extended to amend
+ * The <code>SlingJakartaHttpServletRequestWrapper</code> class is a default wrapper
+ * class around a {@link SlingJakartaHttpServletRequest} which may be extended to amend
* the functionality of the original request object.
+ * @since 2.9.0
*/
-public class SlingHttpServletRequestWrapper extends HttpServletRequestWrapper
- implements SlingHttpServletRequest {
+public class SlingJakartaHttpServletRequestWrapper extends HttpServletRequestWrapper
+ implements SlingJakartaHttpServletRequest {
/**
* Create a wrapper for the supplied wrappedRequest
* @param wrappedRequest The request.
*/
- public SlingHttpServletRequestWrapper(SlingHttpServletRequest wrappedRequest) {
+ public SlingJakartaHttpServletRequestWrapper(SlingJakartaHttpServletRequest wrappedRequest) {
super(wrappedRequest);
}
/**
- * Return the original {@link SlingHttpServletRequest} object wrapped by
+ * Return the original {@link SlingJakartaHttpServletRequest} object wrapped by
* this.
* @return The wrapped request.
*/
- public SlingHttpServletRequest getSlingRequest() {
- return (SlingHttpServletRequest) getRequest();
+ public SlingJakartaHttpServletRequest getSlingRequest() {
+ return (SlingJakartaHttpServletRequest) getRequest();
}
@Override
diff --git a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java b/src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletResponseWrapper.java
similarity index 58%
copy from src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java
copy to src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletResponseWrapper.java
index 317e293..b943a13 100644
--- a/src/main/java/org/apache/sling/api/wrappers/SlingHttpServletResponseWrapper.java
+++ b/src/main/java/org/apache/sling/api/wrappers/SlingJakartaHttpServletResponseWrapper.java
@@ -18,37 +18,38 @@
*/
package org.apache.sling.api.wrappers;
-import javax.servlet.http.HttpServletResponseWrapper;
+import jakarta.servlet.http.HttpServletResponseWrapper;
-import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.api.SlingJakartaHttpServletResponse;
/**
- * The <code>SlingHttpServletResponseWrapper</code> class is a default wrapper
- * class around a {@link SlingHttpServletResponse} which may be extended to
+ * The <code>SlingJakartaHttpServletResponseWrapper</code> class is a default wrapper
+ * class around a {@link SlingJakartaHttpServletResponse} which may be extended to
* amend the functionality of the original response object.
*
- * There's nothing interesting to wrap currently, as the SlingHttpServletResponse
+ * There's nothing interesting to wrap currently, as the SlingJakartaHttpServletResponse
* interface is empty.
- * So this exists only for symmetry with {@link SlingHttpServletRequestWrapper}
+ * So this exists only for symmetry with {@link SlingJakartaHttpServletRequestWrapper}
+ * @since 2.9.0
*/
-public class SlingHttpServletResponseWrapper extends HttpServletResponseWrapper
- implements SlingHttpServletResponse {
+public class SlingJakartaHttpServletResponseWrapper extends HttpServletResponseWrapper
+ implements SlingJakartaHttpServletResponse {
/**
* Create a wrapper for the supplied wrappedRequest
* @param wrappedResponse The response
*/
- public SlingHttpServletResponseWrapper(SlingHttpServletResponse wrappedResponse) {
+ public SlingJakartaHttpServletResponseWrapper(SlingJakartaHttpServletResponse wrappedResponse) {
super(wrappedResponse);
}
/**
- * Return the original {@link SlingHttpServletResponse} object wrapped by
+ * Return the original {@link SlingJakartaHttpServletResponse} object wrapped by
* this.
* @return The wrapped response.
*/
- public SlingHttpServletResponse getSlingResponse() {
- return (SlingHttpServletResponse) getResponse();
+ public SlingJakartaHttpServletResponse getSlingResponse() {
+ return (SlingJakartaHttpServletResponse) getResponse();
}
@Override
diff --git a/src/main/java/org/apache/sling/api/wrappers/package-info.java b/src/main/java/org/apache/sling/api/wrappers/package-info.java
index 8a2b990..162f8cf 100644
--- a/src/main/java/org/apache/sling/api/wrappers/package-info.java
+++ b/src/main/java/org/apache/sling/api/wrappers/package-info.java
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("2.8.0")
+@Version("2.9.0")
package org.apache.sling.api.wrappers;
import org.osgi.annotation.versioning.Version;