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 f9f34ee0e0 Fix javadoc warnings
f9f34ee0e0 is described below
commit f9f34ee0e01f178c5d6acc519153eb50212cceba
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Thu May 2 07:10:49 2024 +0200
Fix javadoc warnings
---
.../http/base/internal/handler/HttpSessionWrapper.java | 4 ++++
.../http/base/internal/registry/ErrorPageRegistry.java | 1 +
.../http/base/internal/registry/EventListenerRegistry.java | 3 +--
.../felix/http/base/internal/registry/HandlerRegistry.java | 1 +
.../base/internal/registry/PerContextHandlerRegistry.java | 4 +++-
.../felix/http/base/internal/registry/ServletRegistry.java | 1 +
.../felix/http/base/internal/runtime/AbstractInfo.java | 5 +++++
.../apache/felix/http/base/internal/runtime/FilterInfo.java | 1 +
.../felix/http/base/internal/runtime/PreprocessorInfo.java | 1 +
.../base/internal/runtime/ServletContextHelperInfo.java | 2 +-
.../felix/http/base/internal/runtime/ServletInfo.java | 5 ++++-
.../http/base/internal/runtime/dto/ErrorPageDTOBuilder.java | 1 +
.../http/base/internal/runtime/dto/FilterDTOBuilder.java | 2 ++
.../base/internal/runtime/dto/PreprocessorDTOBuilder.java | 1 +
.../http/base/internal/runtime/dto/ResourceDTOBuilder.java | 2 ++
.../http/base/internal/runtime/dto/ServletDTOBuilder.java | 1 +
.../apache/felix/http/base/internal/util/ServiceUtils.java | 13 +++++++++++++
.../base/internal/whiteboard/WhiteboardContextHandler.java | 1 +
.../http/base/internal/whiteboard/WhiteboardManager.java | 5 +++--
.../felix/http/jetty/LoadBalancerCustomizerFactory.java | 1 -
.../main/java/org/apache/felix/http/jetty/package-info.java | 3 +++
21 files changed, 50 insertions(+), 8 deletions(-)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/handler/HttpSessionWrapper.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/handler/HttpSessionWrapper.java
index dba883e225..821dbe7403 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/handler/HttpSessionWrapper.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/handler/HttpSessionWrapper.java
@@ -147,6 +147,10 @@ public class HttpSessionWrapper implements HttpSession
/**
* Creates a new {@link HttpSessionWrapper} instance.
+ * @param session The internal session
+ * @param context The servlet context
+ * @param config The configuration
+ * @param terminate Whether to terminate the session
*/
public HttpSessionWrapper(final HttpSession session,
final ExtServletContext context,
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ErrorPageRegistry.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ErrorPageRegistry.java
index 9deee6bda2..83fc1b2301 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ErrorPageRegistry.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ErrorPageRegistry.java
@@ -241,6 +241,7 @@ public final class ErrorPageRegistry
/**
* Remove the servlet from error handling
* @param info The servlet info.
+ * @param destroy Unused
*/
public synchronized void removeServlet(@NotNull final ServletInfo info,
final boolean destroy)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/EventListenerRegistry.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/EventListenerRegistry.java
index 1efabfd055..3d541f0ae4 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/EventListenerRegistry.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/EventListenerRegistry.java
@@ -126,8 +126,7 @@ public final class EventListenerRegistry implements
/**
* Remove listeners
- *
- * @param info
+ * @param info The listener info
*/
public void removeListeners(@NotNull final ListenerInfo info)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/HandlerRegistry.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/HandlerRegistry.java
index 82b0c0a68b..869bfe1e45 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/HandlerRegistry.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/HandlerRegistry.java
@@ -120,6 +120,7 @@ public final class HandlerRegistry
/**
* Add a new context registration.
+ * @param registry The registry
*/
public void add(@NotNull PerContextHandlerRegistry registry)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/PerContextHandlerRegistry.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/PerContextHandlerRegistry.java
index a7dfe63c92..786739174f 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/PerContextHandlerRegistry.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/PerContextHandlerRegistry.java
@@ -65,6 +65,7 @@ public final class PerContextHandlerRegistry implements
Comparable<PerContextHan
/**
* Default http service registry
+ * @param config The configuration
*/
public PerContextHandlerRegistry(@NotNull final HttpConfig config)
{
@@ -78,6 +79,7 @@ public final class PerContextHandlerRegistry implements
Comparable<PerContextHan
/**
* Registry for a servlet context helper (whiteboard support)
* @param info The servlet context helper info
+ * @param config The configuration
*/
public PerContextHandlerRegistry(@NotNull final ServletContextHelperInfo
info, @NotNull final HttpConfig config)
{
@@ -250,7 +252,7 @@ public final class PerContextHandlerRegistry implements
Comparable<PerContextHan
/**
* Register listeners
- * @param listenerHandler
+ * @param listenerHandler The listener handler
*/
public void registerListeners(@NotNull final ListenerHandler
listenerHandler)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ServletRegistry.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ServletRegistry.java
index 78ebd0c316..649fc2ef26 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ServletRegistry.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/registry/ServletRegistry.java
@@ -251,6 +251,7 @@ public final class ServletRegistry
/**
* Remove a servlet
* @param info The servlet info
+ * @param destroy Unused
*/
public synchronized void removeServlet(@NotNull final ServletInfo info,
final boolean destroy)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/AbstractInfo.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/AbstractInfo.java
index cfa29d389b..dd86bb4be5 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/AbstractInfo.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/AbstractInfo.java
@@ -101,6 +101,8 @@ public abstract class AbstractInfo<T> implements
Comparable<AbstractInfo<T>>
/**
* Compare two info objects
+ * @param other The other info object
+ * @return {@code true} if the objects are the same
*/
public boolean isSame(final AbstractInfo<T> other) {
if (this.serviceId != other.serviceId) {
@@ -183,6 +185,9 @@ public abstract class AbstractInfo<T> implements
Comparable<AbstractInfo<T>>
/**
* Get the init parameters.
+ * @param ref The service reference
+ * @param prefix The prefix
+ * @return The map of init parameters
*/
protected Map<String, String> getInitParams(final ServiceReference<T> ref,
final String prefix)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/FilterInfo.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/FilterInfo.java
index 2e25c44b7e..0c75f80935 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/FilterInfo.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/FilterInfo.java
@@ -205,6 +205,7 @@ public class FilterInfo extends
WhiteboardServiceInfo<Filter>
/**
* Returns an immutable map of the init parameters.
+ * @return The init parameters
*/
public Map<String, String> getInitParameters()
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/PreprocessorInfo.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/PreprocessorInfo.java
index 46c3a159ac..ce12ed67e6 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/PreprocessorInfo.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/PreprocessorInfo.java
@@ -49,6 +49,7 @@ public class PreprocessorInfo extends
WhiteboardServiceInfo<Preprocessor>
/**
* Returns an immutable map of the init parameters.
+ * @return The init parameters
*/
public Map<String, String> getInitParameters()
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletContextHelperInfo.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletContextHelperInfo.java
index 5a7b068fec..cfafee933d 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletContextHelperInfo.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletContextHelperInfo.java
@@ -102,7 +102,7 @@ public class ServletContextHelperInfo extends
AbstractInfo<ServletContextHelper>
/**
* Returns an unmodifiable map of the parameters.
- * @return
+ * @return The init parameters
*/
public Map<String, String> getInitParameters()
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletInfo.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletInfo.java
index db40f06902..ca9b6e323e 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletInfo.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/ServletInfo.java
@@ -175,6 +175,9 @@ public class ServletInfo extends
WhiteboardServiceInfo<Servlet>
/**
* Constructor for Http Service
+ * @param name The servlet name
+ * @param pattern The pattern
+ * @param initParams The init parameters
*/
public ServletInfo(final String name,
final String pattern,
@@ -236,7 +239,7 @@ public class ServletInfo extends
WhiteboardServiceInfo<Servlet>
/**
* Returns an unmodifiable map of the init parameters.
- * @return
+ * @return The init parameters
*/
public Map<String, String> getInitParameters()
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ErrorPageDTOBuilder.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ErrorPageDTOBuilder.java
index af4169a6bc..a76b03b6e3 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ErrorPageDTOBuilder.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ErrorPageDTOBuilder.java
@@ -48,6 +48,7 @@ public final class ErrorPageDTOBuilder extends
BaseServletDTOBuilder
/**
* Build a servlet DTO from a servlet info
* @param info The servlet info
+ * @param failed Whether the servlet registration failed
* @return A servlet DTO
*/
public static ErrorPageDTO build(final ServletInfo info, final boolean
failed)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/FilterDTOBuilder.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/FilterDTOBuilder.java
index 528dcefcd4..e1b6e45aea 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/FilterDTOBuilder.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/FilterDTOBuilder.java
@@ -51,6 +51,7 @@ public final class FilterDTOBuilder
/**
* Build a filter DTO from a filter handler
* @param handler The filter handler
+ * @param reason The reason for the failure
* @return A filter DTO
*/
public static @NotNull FilterDTO build(@NotNull final FilterHandler
handler, final int reason)
@@ -66,6 +67,7 @@ public final class FilterDTOBuilder
/**
* Build a filter DTO from a filter info
* @param info The filter info
+ * @param reason The reason for the failure
* @return A filter DTO
*/
public static @NotNull FilterDTO build(@NotNull final FilterInfo info,
final int reason)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/PreprocessorDTOBuilder.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/PreprocessorDTOBuilder.java
index 2964719a9c..0bf7dacd78 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/PreprocessorDTOBuilder.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/PreprocessorDTOBuilder.java
@@ -30,6 +30,7 @@ public final class PreprocessorDTOBuilder
/**
* Build a preprocessor DTO from a filter info
* @param info The preprocessor info
+ * @param reason The reason for the failure or -1 if the preprocessor was
registered successfully
* @return A preprocessor DTO
*/
public static @NotNull PreprocessorDTO build(@NotNull final
PreprocessorInfo info, final int reason)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ResourceDTOBuilder.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ResourceDTOBuilder.java
index 579f3baf05..70e137a1a4 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ResourceDTOBuilder.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ResourceDTOBuilder.java
@@ -49,6 +49,7 @@ public final class ResourceDTOBuilder
/**
* Build a servlet DTO from a servlet info
* @param info The servlet info
+ * @param failed Whether the registration failed
* @return A servlet DTO
*/
public static ResourceDTO build(final ServletInfo info, final boolean
failed)
@@ -65,6 +66,7 @@ public final class ResourceDTOBuilder
/**
* Build a servlet DTO from a servlet info
* @param info The servlet info
+ * @param failed Whether the registration failed
* @return A servlet DTO
*/
public static ResourceDTO build(final ResourceInfo info, final boolean
failed)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ServletDTOBuilder.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ServletDTOBuilder.java
index 9346aad874..8ee0fd671e 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ServletDTOBuilder.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/runtime/dto/ServletDTOBuilder.java
@@ -44,6 +44,7 @@ public final class ServletDTOBuilder extends
BaseServletDTOBuilder
/**
* Build a servlet DTO from a servlet info
* @param info The servlet info
+ * @param reason The reason for the failure or -1 if the servlet was
registered successfully
* @return A servlet DTO
*/
public static ServletDTO build(final ServletInfo info, final int reason)
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/util/ServiceUtils.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/util/ServiceUtils.java
index 3cb8b2406a..d3646eac94 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/util/ServiceUtils.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/util/ServiceUtils.java
@@ -31,6 +31,9 @@ public abstract class ServiceUtils {
/**
* Get the service
+ * @param ctx The bundle context
+ * @param ref The service reference
+ * @param <T> The service type
* @return The service or {@code null}
*/
public static <T> T safeGetService(final BundleContext ctx, final
ServiceReference<T> ref) {
@@ -44,6 +47,9 @@ public abstract class ServiceUtils {
/**
* Unget the service
+ * @param ctx The bundle context
+ * @param ref The service reference
+ * @param <T> The service type
*/
public static <T> void safeUngetService(final BundleContext ctx, final
ServiceReference<T> ref) {
try {
@@ -55,6 +61,9 @@ public abstract class ServiceUtils {
/**
* Get the service using {@code ServiceObjects}
+ * @param ctx The bundle context
+ * @param ref The service reference
+ * @param <T> The service type
* @return The service or {@code null}
*/
public static <T> T safeGetServiceObjects(final BundleContext ctx, final
ServiceReference<T> ref) {
@@ -72,6 +81,10 @@ public abstract class ServiceUtils {
/**
* Unget the service using {@code ServiceObjects}
+ * @param ctx The bundle context
+ * @param ref The service reference
+ * @param service The service
+ * @param <T> The service type
*/
public static <T> void safeUngetServiceObjects(final BundleContext ctx,
final ServiceReference<T> ref, final T service) {
if ( ctx != null && service != null ) {
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardContextHandler.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardContextHandler.java
index 7764faa28d..1544cff7d1 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardContextHandler.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardContextHandler.java
@@ -108,6 +108,7 @@ public class WhiteboardContextHandler implements
Comparable<WhiteboardContextHan
/**
* Deactivate this context.
+ * @param registry The handler registry
*/
public void deactivate(@NotNull final HandlerRegistry registry)
{
diff --git
a/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardManager.java
b/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardManager.java
index 7d95499eb2..cb48cb9a53 100644
---
a/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardManager.java
+++
b/http/base/src/main/java/org/apache/felix/http/base/internal/whiteboard/WhiteboardManager.java
@@ -141,6 +141,7 @@ public final class WhiteboardManager
/**
* Start the whiteboard manager
* @param containerContext The servlet context
+ * @param httpServiceProps Service registration properties
*/
public void start(final ServletContext containerContext, @NotNull final
Dictionary<String, Object> httpServiceProps)
{
@@ -929,8 +930,8 @@ public final class WhiteboardManager
* @param req The request
* @param res The response
* @param dispatcher The dispatcher
- * @throws IOException
- * @throws ServletException
+ * @throws IOException If the invocation throws an IOException
+ * @throws ServletException If the invocation throws a ServletException
*/
public void invokePreprocessors(final HttpServletRequest req,
final HttpServletResponse res,
diff --git
a/http/jetty12/src/main/java/org/apache/felix/http/jetty/LoadBalancerCustomizerFactory.java
b/http/jetty12/src/main/java/org/apache/felix/http/jetty/LoadBalancerCustomizerFactory.java
index 8a7b78d1c4..0b03aecde2 100644
---
a/http/jetty12/src/main/java/org/apache/felix/http/jetty/LoadBalancerCustomizerFactory.java
+++
b/http/jetty12/src/main/java/org/apache/felix/http/jetty/LoadBalancerCustomizerFactory.java
@@ -38,7 +38,6 @@ public interface LoadBalancerCustomizerFactory
/**
* Creates new Jetty {@code Customizer} instances.
*
- * <p>
* @return A configured Jetty {@code Customizer} instance or {@code null}
* if the customizer can't be created.
*/
diff --git
a/http/jetty12/src/main/java/org/apache/felix/http/jetty/package-info.java
b/http/jetty12/src/main/java/org/apache/felix/http/jetty/package-info.java
index 342f9e0a0b..41d68493ee 100644
--- a/http/jetty12/src/main/java/org/apache/felix/http/jetty/package-info.java
+++ b/http/jetty12/src/main/java/org/apache/felix/http/jetty/package-info.java
@@ -16,6 +16,9 @@
* specific language governing permissions and limitations
* under the License.
*/
+/**
+ * This package provides the Jetty-based implementation of the HTTP service.
+ */
@Version("4.0")
package org.apache.felix.http.jetty;
