You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by da...@apache.org on 2021/02/22 18:45:12 UTC
[sling-org-apache-sling-engine] branch master updated: Fix javadoc
generation process for release
This is an automated email from the ASF dual-hosted git repository.
davidb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-engine.git
The following commit(s) were added to refs/heads/master by this push:
new dc2f11f Fix javadoc generation process for release
dc2f11f is described below
commit dc2f11f05356090e49ab9e6ff41fa8d97d94c1cc
Author: David Bosschaert <bo...@adobe.com>
AuthorDate: Mon Feb 22 17:08:41 2021 +0000
Fix javadoc generation process for release
---
pom.xml | 4 ++++
.../impl/console/WebConsoleConfigPrinter.java | 6 ++++-
.../impl/filter/RequestSlingFilterChain.java | 4 ++--
.../impl/filter/SlingComponentFilterChain.java | 5 ++--
.../engine/impl/filter/SlingFilterChainHelper.java | 4 +++-
.../engine/impl/helper/SlingFilterConfig.java | 5 +++-
.../engine/impl/helper/SlingServletContext.java | 5 ++++
.../engine/impl/request/FastMessageFormat.java | 4 ++++
.../sling/engine/impl/request/RequestData.java | 27 +++++++++++++++++-----
.../engine/impl/request/SlingRequestPathInfo.java | 8 +++++--
.../impl/request/SlingRequestProgressTracker.java | 4 +++-
11 files changed, 60 insertions(+), 16 deletions(-)
diff --git a/pom.xml b/pom.xml
index 6b221e9..6e36b57 100644
--- a/pom.xml
+++ b/pom.xml
@@ -71,6 +71,10 @@
<dependencies>
<dependency>
<groupId>org.osgi</groupId>
+ <artifactId>org.osgi.annotation.bundle</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
<artifactId>org.osgi.annotation.versioning</artifactId>
</dependency>
<dependency>
diff --git a/src/main/java/org/apache/sling/engine/impl/console/WebConsoleConfigPrinter.java b/src/main/java/org/apache/sling/engine/impl/console/WebConsoleConfigPrinter.java
index e36dd74..1e4b4ad 100644
--- a/src/main/java/org/apache/sling/engine/impl/console/WebConsoleConfigPrinter.java
+++ b/src/main/java/org/apache/sling/engine/impl/console/WebConsoleConfigPrinter.java
@@ -82,7 +82,11 @@ public class WebConsoleConfigPrinter {
/**
* Print out the servlet filter chains.
- * @see org.apache.felix.webconsole.ConfigurationPrinter#printConfiguration(java.io.PrintWriter)
+ *
+ * @param pw the writer to use.
+ *
+ * <p>
+ * see org.apache.felix.webconsole.ConfigurationPrinter#printConfiguration(java.io.PrintWriter)
*/
public void printConfiguration(PrintWriter pw) {
pw.println("Current Apache Sling Servlet Filter Configuration");
diff --git a/src/main/java/org/apache/sling/engine/impl/filter/RequestSlingFilterChain.java b/src/main/java/org/apache/sling/engine/impl/filter/RequestSlingFilterChain.java
index f0af161..535f7bc 100644
--- a/src/main/java/org/apache/sling/engine/impl/filter/RequestSlingFilterChain.java
+++ b/src/main/java/org/apache/sling/engine/impl/filter/RequestSlingFilterChain.java
@@ -31,7 +31,7 @@ import org.apache.sling.engine.impl.filter.ServletFilterManager.FilterChainType;
/**
* The <code>RequestSlingFilterChain</code> implements the filter chain for
* request scoped filters. It is used by the
- * {@link SlingMainServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)}
+ * {@link SlingMainServlet#service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}
* method to dispatch request processing.
*/
public class RequestSlingFilterChain extends AbstractSlingFilterChain {
@@ -48,4 +48,4 @@ public class RequestSlingFilterChain extends AbstractSlingFilterChain {
IOException {
handler.processComponent(request, response,FilterChainType.COMPONENT);
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/sling/engine/impl/filter/SlingComponentFilterChain.java b/src/main/java/org/apache/sling/engine/impl/filter/SlingComponentFilterChain.java
index 87a93f0..cca4408 100644
--- a/src/main/java/org/apache/sling/engine/impl/filter/SlingComponentFilterChain.java
+++ b/src/main/java/org/apache/sling/engine/impl/filter/SlingComponentFilterChain.java
@@ -29,7 +29,8 @@ import org.apache.sling.engine.impl.request.RequestData;
/**
* The <code>SlingComponentFilterChain</code> implements the filter chain for
* component scoped filters. It is used by the
- * {@link org.apache.sling.engine.impl.SlingMainServlet#processRequest(SlingHttpServletRequest, SlingHttpServletResponse)}
+ * {@link org.apache.sling.engine.impl.SlingMainServlet#service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}
+ *
* method to dispatch component processing.
*/
public class SlingComponentFilterChain extends AbstractSlingFilterChain {
@@ -43,4 +44,4 @@ public class SlingComponentFilterChain extends AbstractSlingFilterChain {
ServletException {
RequestData.service(request, response);
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/sling/engine/impl/filter/SlingFilterChainHelper.java b/src/main/java/org/apache/sling/engine/impl/filter/SlingFilterChainHelper.java
index 9402b38..24fcb90 100644
--- a/src/main/java/org/apache/sling/engine/impl/filter/SlingFilterChainHelper.java
+++ b/src/main/java/org/apache/sling/engine/impl/filter/SlingFilterChainHelper.java
@@ -72,6 +72,8 @@ public class SlingFilterChainHelper {
* Returns the list of <code>Filter</code>s added to this instance
* or <code>null</code> if no filters have been added.
* This method doesn't need to be synced as it is called from synced methods.
+ *
+ * @return the filters
*/
public FilterHandle[] getFilters() {
return filters;
@@ -83,4 +85,4 @@ public class SlingFilterChainHelper {
}
return filterList.toArray(new FilterHandle[filterList.size()]);
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/sling/engine/impl/helper/SlingFilterConfig.java b/src/main/java/org/apache/sling/engine/impl/helper/SlingFilterConfig.java
index 66e41e7..fc83718 100644
--- a/src/main/java/org/apache/sling/engine/impl/helper/SlingFilterConfig.java
+++ b/src/main/java/org/apache/sling/engine/impl/helper/SlingFilterConfig.java
@@ -97,6 +97,9 @@ public class SlingFilterConfig implements FilterConfig {
* comment at the top for the list of properties checked by this method. As the
* service id is part of the checked property list this method always returns a
* name.
+ *
+ * @param reference the filter service
+ * @return the name
*/
public static String getName(ServiceReference<Filter> reference) {
String servletName = null;
@@ -117,4 +120,4 @@ public class SlingFilterConfig implements FilterConfig {
public String getFilterName() {
return name;
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/sling/engine/impl/helper/SlingServletContext.java b/src/main/java/org/apache/sling/engine/impl/helper/SlingServletContext.java
index fd7029b..9a24cd0 100644
--- a/src/main/java/org/apache/sling/engine/impl/helper/SlingServletContext.java
+++ b/src/main/java/org/apache/sling/engine/impl/helper/SlingServletContext.java
@@ -102,6 +102,9 @@ public class SlingServletContext implements ServletContext {
* has been fully initialized. Otherwise the {@link #getServletContext()}
* method may cause a {@link NullPointerException} !
* @see #dispose()
+ *
+ * @param bundleContext the OSGi Bundle Context
+ * @param slingMainServlet the main servlet
*/
public SlingServletContext(final BundleContext bundleContext,
final SlingMainServlet slingMainServlet) {
@@ -659,6 +662,8 @@ public class SlingServletContext implements ServletContext {
/**
* Returns the real servlet context of the servlet container in which the
* Sling Servlet is running.
+ *
+ * @return the servlet context
*/
protected ServletContext getServletContext() {
return slingMainServlet.getServletContext();
diff --git a/src/main/java/org/apache/sling/engine/impl/request/FastMessageFormat.java b/src/main/java/org/apache/sling/engine/impl/request/FastMessageFormat.java
index 210ce4a..e7a8dc9 100644
--- a/src/main/java/org/apache/sling/engine/impl/request/FastMessageFormat.java
+++ b/src/main/java/org/apache/sling/engine/impl/request/FastMessageFormat.java
@@ -57,6 +57,10 @@ public class FastMessageFormat {
/**
* Use this method exactly like {@link MessageFormat#format(String, Object...)}.
*
+ * @param pattern the pattern to use
+ * @param arguments the objects to format
+ * @return the string which has been formatted.
+ *
* @see MessageFormat#format(String, Object...)
*/
public String format(String pattern, Object... arguments) {
diff --git a/src/main/java/org/apache/sling/engine/impl/request/RequestData.java b/src/main/java/org/apache/sling/engine/impl/request/RequestData.java
index 9bc0ffe..e11c15c 100644
--- a/src/main/java/org/apache/sling/engine/impl/request/RequestData.java
+++ b/src/main/java/org/apache/sling/engine/impl/request/RequestData.java
@@ -303,6 +303,8 @@ public class RequestData {
/**
* Unwraps the ServletRequest to a SlingHttpServletRequest.
*
+ * @param request the request
+ * @return the unwrapped request
* @throws IllegalArgumentException If the <code>request</code> is not a
* <code>SlingHttpServletRequest</code> and not a
* <code>ServletRequestWrapper</code> wrapping a
@@ -334,7 +336,8 @@ public class RequestData {
/**
* Unwraps the SlingHttpServletRequest to a SlingHttpServletRequestImpl
*
- * @param request
+ * @param request the request
+ * @return the unwrapped request
* @throws IllegalArgumentException If <code>request</code> is not a
* <code>SlingHttpServletRequestImpl</code> and not
* <code>SlingHttpServletRequestWrapper</code> wrapping a
@@ -357,6 +360,8 @@ public class RequestData {
/**
* Unwraps the ServletRequest to a SlingHttpServletRequest.
*
+ * @param response the response
+ * @return the unwrapped response
* @throws IllegalArgumentException If the <code>response</code> is not a
* <code>SlingHttpServletResponse</code> and not a
* <code>ServletResponseWrapper</code> wrapping a
@@ -388,7 +393,8 @@ public class RequestData {
/**
* Unwraps a SlingHttpServletResponse to a SlingHttpServletResponseImpl
*
- * @param response
+ * @param response the response
+ * @return the unwrapped response
* @throws IllegalArgumentException If <code>response</code> is not a
* <code>SlingHttpServletResponseImpl</code> and not
* <code>SlingHttpServletResponseWrapper</code> wrapping a
@@ -409,7 +415,8 @@ public class RequestData {
}
/**
- * @param request
+ * @param request the request
+ * @return the request data
* @throws IllegalArgumentException If the <code>request</code> is not a
* <code>SlingHttpServletRequest</code> and not a
* <code>ServletRequestWrapper</code> wrapping a
@@ -420,7 +427,8 @@ public class RequestData {
}
/**
- * @param request
+ * @param request the request
+ * @return the request data
* @throws IllegalArgumentException If <code>request</code> is not a
* <code>SlingHttpServletRequestImpl</code> and not
* <code>SlingHttpServletRequestWrapper</code> wrapping a
@@ -431,7 +439,8 @@ public class RequestData {
}
/**
- * @param request
+ * @param request the request
+ * @return the sling http servlet request
* @throws IllegalArgumentException if <code>request</code> is not a
* <code>HttpServletRequest</code> of if <code>request</code>
* is not backed by <code>SlingHttpServletRequestImpl</code>.
@@ -464,7 +473,8 @@ public class RequestData {
}
/**
- * @param response
+ * @param response the response
+ * @return the sling http servlet response
* @throws IllegalArgumentException if <code>response</code> is not a
* <code>HttpServletResponse</code> of if
* <code>response</code> is not backed by
@@ -669,6 +679,9 @@ public class RequestData {
/**
* Sets the name of the currently active servlet and returns the name of the
* previously active servlet.
+ *
+ * @param servletName the servlet name
+ * @return the previous servlet name
*/
public String setActiveServletName(String servletName) {
String old = activeServletName;
@@ -682,6 +695,8 @@ public class RequestData {
* the case of an uncaught <code>Throwable</code> at the end of request
* processing, this is the name of the servlet causing the uncaught
* <code>Throwable</code>.
+ *
+ * @return the current servlet name
*/
public String getActiveServletName() {
return activeServletName;
diff --git a/src/main/java/org/apache/sling/engine/impl/request/SlingRequestPathInfo.java b/src/main/java/org/apache/sling/engine/impl/request/SlingRequestPathInfo.java
index 3763f20..4963707 100644
--- a/src/main/java/org/apache/sling/engine/impl/request/SlingRequestPathInfo.java
+++ b/src/main/java/org/apache/sling/engine/impl/request/SlingRequestPathInfo.java
@@ -29,7 +29,7 @@ import org.apache.sling.api.resource.Resource;
* not used to locate the Resource, and we split that part in different
* subparts: selectors, extension and suffix.
*
- * @see SlingRequestPathInfoTest for a number of examples.
+ * see SlingRequestPathInfoTest for a number of examples.
*/
public class SlingRequestPathInfo implements RequestPathInfo {
@@ -47,7 +47,11 @@ public class SlingRequestPathInfo implements RequestPathInfo {
private final static String[] NO_SELECTORS = new String[0];
- /** break requestPath as required by SlingRequestPathInfo */
+ /**
+ * Break requestPath as required by SlingRequestPathInfo.
+ *
+ * @param r the resource
+ */
public SlingRequestPathInfo(Resource r) {
// ensure the resource
diff --git a/src/main/java/org/apache/sling/engine/impl/request/SlingRequestProgressTracker.java b/src/main/java/org/apache/sling/engine/impl/request/SlingRequestProgressTracker.java
index 3fbd8ab..df2c237 100644
--- a/src/main/java/org/apache/sling/engine/impl/request/SlingRequestProgressTracker.java
+++ b/src/main/java/org/apache/sling/engine/impl/request/SlingRequestProgressTracker.java
@@ -140,7 +140,9 @@ public class SlingRequestProgressTracker implements RequestProgressTracker {
}
/**
- * Creates a new request progress tracker and logs initial messages about the supplied request
+ * Creates a new request progress tracker and logs initial messages about the supplied request.
+ *
+ * @param request the request
*/
public SlingRequestProgressTracker(HttpServletRequest request) {
reset();