From 3b00041caf21a7d9bf422cec9511b7af02e563d8 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Sun, 17 Dec 2017 00:12:44 +0100 Subject: [PATCH] Fix javadoc in org.eclipse.jgit.http.server Change-Id: I732d773b21bbf64285493070964dd9e442eab5d8 Signed-off-by: Matthias Sohn --- .../jgit/http/server/AsIsFileFilter.java | 3 ++ .../jgit/http/server/ClientVersionUtil.java | 10 ++++- .../eclipse/jgit/http/server/GitFilter.java | 43 ++++++++++++------- .../eclipse/jgit/http/server/GitServlet.java | 39 +++++++++++------ .../jgit/http/server/GitSmartHttpTools.java | 4 +- .../jgit/http/server/HttpServerText.java | 2 + .../jgit/http/server/InfoPacksServlet.java | 1 + .../jgit/http/server/InfoRefsServlet.java | 1 + .../jgit/http/server/IsLocalFilter.java | 3 ++ .../jgit/http/server/NoCacheFilter.java | 5 ++- .../jgit/http/server/ObjectFileServlet.java | 2 + .../jgit/http/server/ReceivePackServlet.java | 1 + .../jgit/http/server/RepositoryFilter.java | 25 +++++++---- .../jgit/http/server/ServletUtils.java | 4 +- .../jgit/http/server/SmartOutputStream.java | 2 + .../http/server/SmartServiceInfoRefs.java | 24 +++++++++++ .../jgit/http/server/TextFileServlet.java | 1 + .../jgit/http/server/UploadPackServlet.java | 1 + .../jgit/http/server/glue/ErrorServlet.java | 5 ++- .../jgit/http/server/glue/MetaFilter.java | 7 ++- .../jgit/http/server/glue/MetaServlet.java | 13 +++++- .../server/glue/NoParameterFilterConfig.java | 4 ++ .../http/server/glue/RegexGroupFilter.java | 14 ++++-- .../jgit/http/server/glue/RegexPipeline.java | 1 + .../jgit/http/server/glue/ServletBinder.java | 8 +++- .../http/server/glue/ServletBinderImpl.java | 14 +++++- .../jgit/http/server/glue/SuffixPipeline.java | 1 + .../jgit/http/server/glue/WrappedRequest.java | 7 ++- .../http/server/resolver/AsIsFileService.java | 12 +++--- .../resolver/DefaultReceivePackFactory.java | 7 ++- .../resolver/DefaultUploadPackFactory.java | 4 +- 31 files changed, 204 insertions(+), 64 deletions(-) diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java index 05391eb75d..7f826d4f27 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java @@ -70,16 +70,19 @@ class AsIsFileFilter implements Filter { this.asIs = getAnyFile; } + /** {@inheritDoc} */ @Override public void init(FilterConfig config) throws ServletException { // Do nothing. } + /** {@inheritDoc} */ @Override public void destroy() { // Do nothing. } + /** {@inheritDoc} */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java index c0d4b5e4db..38a9ea75e7 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java @@ -47,13 +47,19 @@ import static org.eclipse.jgit.http.server.ServletUtils.isChunked; import javax.servlet.http.HttpServletRequest; -/** Parses Git client User-Agent strings. */ +/** + * Parses Git client User-Agent strings. + */ public class ClientVersionUtil { private static final int[] v1_7_5 = { 1, 7, 5 }; private static final int[] v1_7_8_6 = { 1, 7, 8, 6 }; private static final int[] v1_7_9 = { 1, 7, 9 }; - /** @return maximum version array, indicating an invalid version of Git. */ + /** + * An invalid version of Git + * + * @return maximum version array, indicating an invalid version of Git. + */ public static int[] invalidVersion() { return new int[] { Integer.MAX_VALUE }; } diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java index 807037155c..2ebe1b7d2f 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java @@ -62,8 +62,6 @@ import org.eclipse.jgit.http.server.resolver.AsIsFileService; import org.eclipse.jgit.http.server.resolver.DefaultReceivePackFactory; import org.eclipse.jgit.http.server.resolver.DefaultUploadPackFactory; import org.eclipse.jgit.lib.Constants; -import org.eclipse.jgit.transport.ReceivePack; -import org.eclipse.jgit.transport.UploadPack; import org.eclipse.jgit.transport.resolver.FileResolver; import org.eclipse.jgit.transport.resolver.ReceivePackFactory; import org.eclipse.jgit.transport.resolver.RepositoryResolver; @@ -74,15 +72,16 @@ import org.eclipse.jgit.util.StringUtils; * Handles Git repository access over HTTP. *

* Applications embedding this filter should map a directory path within the - * application to this filter. For a servlet version, see {@link GitServlet}. + * application to this filter. For a servlet version, see + * {@link org.eclipse.jgit.http.server.GitServlet}. *

* Applications may wish to add additional repository action URLs to this - * servlet by taking advantage of its extension from {@link MetaFilter}. - * Callers may register their own URL suffix translations through - * {@link #serve(String)}, or their regex translations through - * {@link #serveRegex(String)}. Each translation should contain a complete - * filter pipeline which ends with the HttpServlet that should handle the - * requested action. + * servlet by taking advantage of its extension from + * {@link org.eclipse.jgit.http.server.glue.MetaFilter}. Callers may register + * their own URL suffix translations through {@link #serve(String)}, or their + * regex translations through {@link #serveRegex(String)}. Each translation + * should contain a complete filter pipeline which ends with the HttpServlet + * that should handle the requested action. */ public class GitFilter extends MetaFilter { private volatile boolean initialized; @@ -124,6 +123,8 @@ public class GitFilter extends MetaFilter { } /** + * Set AsIsFileService + * * @param f * the filter to validate direct access to repository files * through a dumb client. If {@code null} then dumb client @@ -135,9 +136,12 @@ public class GitFilter extends MetaFilter { } /** + * Set upload-pack factory + * * @param f - * the factory to construct and configure an {@link UploadPack} - * session when a fetch or clone is requested by a client. + * the factory to construct and configure an + * {@link org.eclipse.jgit.transport.UploadPack} session when a + * fetch or clone is requested by a client. */ @SuppressWarnings("unchecked") public void setUploadPackFactory(UploadPackFactory f) { @@ -146,10 +150,12 @@ public class GitFilter extends MetaFilter { } /** + * Add upload-pack filter + * * @param filter * filter to apply before any of the UploadPack operations. The * UploadPack instance is available in the request attribute - * {@link ServletUtils#ATTRIBUTE_HANDLER}. + * {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}. */ public void addUploadPackFilter(Filter filter) { assertNotInitialized(); @@ -157,9 +163,12 @@ public class GitFilter extends MetaFilter { } /** + * Set the receive-pack factory + * * @param f - * the factory to construct and configure a {@link ReceivePack} - * session when a push is requested by a client. + * the factory to construct and configure a + * {@link org.eclipse.jgit.transport.ReceivePack} session when a + * push is requested by a client. */ @SuppressWarnings("unchecked") public void setReceivePackFactory(ReceivePackFactory f) { @@ -168,10 +177,12 @@ public class GitFilter extends MetaFilter { } /** + * Add receive-pack filter + * * @param filter * filter to apply before any of the ReceivePack operations. The * ReceivePack instance is available in the request attribute - * {@link ServletUtils#ATTRIBUTE_HANDLER}. + * {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}. */ public void addReceivePackFilter(Filter filter) { assertNotInitialized(); @@ -183,6 +194,7 @@ public class GitFilter extends MetaFilter { throw new IllegalStateException(HttpServerText.get().alreadyInitializedByContainer); } + /** {@inheritDoc} */ @Override public void init(FilterConfig filterConfig) throws ServletException { super.init(filterConfig); @@ -297,6 +309,7 @@ public class GitFilter extends MetaFilter { } } + /** {@inheritDoc} */ @Override protected ServletBinder register(ServletBinder binder) { if (resolver == null) diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java index 3a5edeebee..ee23677caa 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java @@ -54,8 +54,6 @@ import javax.servlet.http.HttpServletRequest; import org.eclipse.jgit.http.server.glue.MetaServlet; import org.eclipse.jgit.http.server.resolver.AsIsFileService; -import org.eclipse.jgit.transport.ReceivePack; -import org.eclipse.jgit.transport.UploadPack; import org.eclipse.jgit.transport.resolver.ReceivePackFactory; import org.eclipse.jgit.transport.resolver.RepositoryResolver; import org.eclipse.jgit.transport.resolver.UploadPackFactory; @@ -87,12 +85,12 @@ import org.eclipse.jgit.transport.resolver.UploadPackFactory; * *

* Applications may wish to add additional repository action URLs to this - * servlet by taking advantage of its extension from {@link MetaServlet}. - * Callers may register their own URL suffix translations through - * {@link #serve(String)}, or their regex translations through - * {@link #serveRegex(String)}. Each translation should contain a complete - * filter pipeline which ends with the HttpServlet that should handle the - * requested action. + * servlet by taking advantage of its extension from + * {@link org.eclipse.jgit.http.server.glue.MetaServlet}. Callers may register + * their own URL suffix translations through {@link #serve(String)}, or their + * regex translations through {@link #serveRegex(String)}. Each translation + * should contain a complete filter pipeline which ends with the HttpServlet + * that should handle the requested action. */ public class GitServlet extends MetaServlet { private static final long serialVersionUID = 1L; @@ -124,6 +122,8 @@ public class GitServlet extends MetaServlet { } /** + * Set AsIsFileService + * * @param f * the filter to validate direct access to repository files * through a dumb client. If {@code null} then dumb client @@ -134,43 +134,54 @@ public class GitServlet extends MetaServlet { } /** + * Set upload-pack factory + * * @param f - * the factory to construct and configure an {@link UploadPack} - * session when a fetch or clone is requested by a client. + * the factory to construct and configure an + * {@link org.eclipse.jgit.transport.UploadPack} session when a + * fetch or clone is requested by a client. */ public void setUploadPackFactory(UploadPackFactory f) { gitFilter.setUploadPackFactory(f); } /** + * Add upload-pack filter + * * @param filter * filter to apply before any of the UploadPack operations. The * UploadPack instance is available in the request attribute - * {@link ServletUtils#ATTRIBUTE_HANDLER}. + * {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}. */ public void addUploadPackFilter(Filter filter) { gitFilter.addUploadPackFilter(filter); } /** + * Set receive-pack factory + * * @param f - * the factory to construct and configure a {@link ReceivePack} - * session when a push is requested by a client. + * the factory to construct and configure a + * {@link org.eclipse.jgit.transport.ReceivePack} session when a + * push is requested by a client. */ public void setReceivePackFactory(ReceivePackFactory f) { gitFilter.setReceivePackFactory(f); } /** + * Add receive-pack filter + * * @param filter * filter to apply before any of the ReceivePack operations. The * ReceivePack instance is available in the request attribute - * {@link ServletUtils#ATTRIBUTE_HANDLER}. + * {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}. */ public void addReceivePackFilter(Filter filter) { gitFilter.addReceivePackFilter(filter); } + /** {@inheritDoc} */ @Override public void init(final ServletConfig config) throws ServletException { gitFilter.init(new FilterConfig() { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitSmartHttpTools.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitSmartHttpTools.java index cfe48223da..d6955b4a58 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitSmartHttpTools.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitSmartHttpTools.java @@ -154,9 +154,9 @@ public class GitSmartHttpTools { * an HTTP response code is returned instead. *

* This method may only be called before handing off the request to - * {@link UploadPack#upload(java.io.InputStream, OutputStream, OutputStream)} + * {@link org.eclipse.jgit.transport.UploadPack#upload(java.io.InputStream, OutputStream, OutputStream)} * or - * {@link ReceivePack#receive(java.io.InputStream, OutputStream, OutputStream)}. + * {@link org.eclipse.jgit.transport.ReceivePack#receive(java.io.InputStream, OutputStream, OutputStream)}. * * @param req * current request. diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java index dff90a6c8b..fbb2061fa3 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java @@ -52,6 +52,8 @@ import org.eclipse.jgit.nls.TranslationBundle; public class HttpServerText extends TranslationBundle { /** + * Get an instance of this translation bundle + * * @return an instance of this translation bundle */ public static HttpServerText get() { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java index 91c2f9fd9e..830e0611b7 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java @@ -60,6 +60,7 @@ import org.eclipse.jgit.lib.ObjectDatabase; class InfoPacksServlet extends HttpServlet { private static final long serialVersionUID = 1L; + /** {@inheritDoc} */ @Override public void doGet(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java index 72c71369dc..ccb76adca0 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java @@ -64,6 +64,7 @@ import org.eclipse.jgit.util.HttpSupport; class InfoRefsServlet extends HttpServlet { private static final long serialVersionUID = 1L; + /** {@inheritDoc} */ @Override public void doGet(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java index 223813feb3..b0b831f3d6 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java @@ -66,16 +66,19 @@ import org.eclipse.jgit.lib.Repository; * downstream servlet can directly access its contents on disk. */ class IsLocalFilter implements Filter { + /** {@inheritDoc} */ @Override public void init(FilterConfig config) throws ServletException { // Do nothing. } + /** {@inheritDoc} */ @Override public void destroy() { // Do nothing. } + /** {@inheritDoc} */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java index bdc3420aa9..5177858b1f 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java @@ -57,18 +57,21 @@ import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletResponse; -/** Adds HTTP response headers to prevent caching by proxies/browsers. */ +/** Add HTTP response headers to prevent caching by proxies/browsers. */ class NoCacheFilter implements Filter { + /** {@inheritDoc} */ @Override public void init(FilterConfig config) throws ServletException { // Do nothing. } + /** {@inheritDoc} */ @Override public void destroy() { // Do nothing. } + /** {@inheritDoc} */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java index babc036dfc..50dc68f99f 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java @@ -117,12 +117,14 @@ abstract class ObjectFileServlet extends HttpServlet { abstract String etag(FileSender sender) throws IOException; + /** {@inheritDoc} */ @Override public void doGet(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { serve(req, rsp, true); } + /** {@inheritDoc} */ @Override protected void doHead(final HttpServletRequest req, final HttpServletResponse rsp) throws ServletException, IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java index 9d24bf7d07..a46652ee42 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java @@ -165,6 +165,7 @@ class ReceivePackServlet extends HttpServlet { } } + /** {@inheritDoc} */ @Override public void doPost(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java index de09c545e5..c89a5d762c 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java @@ -71,16 +71,19 @@ import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException; import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException; /** - * Opens a repository named by the path info through {@link RepositoryResolver}. + * Open a repository named by the path info through + * {@link org.eclipse.jgit.transport.resolver.RepositoryResolver}. *

- * This filter assumes it is invoked by {@link GitServlet} and is likely to not - * work as expected if called from any other class. This filter assumes the path - * info of the current request is a repository name which can be used by the - * configured {@link RepositoryResolver} to open a {@link Repository} and attach - * it to the current request. + * This filter assumes it is invoked by + * {@link org.eclipse.jgit.http.server.GitServlet} and is likely to not work as + * expected if called from any other class. This filter assumes the path info of + * the current request is a repository name which can be used by the configured + * {@link org.eclipse.jgit.transport.resolver.RepositoryResolver} to open a + * {@link org.eclipse.jgit.lib.Repository} and attach it to the current request. *

- * This filter sets request attribute {@link ServletUtils#ATTRIBUTE_REPOSITORY} - * when it discovers the repository, and automatically closes and removes the + * This filter sets request attribute + * {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_REPOSITORY} when + * it discovers the repository, and automatically closes and removes the * attribute when the request is complete. */ public class RepositoryFilter implements Filter { @@ -93,23 +96,27 @@ public class RepositoryFilter implements Filter { * * @param resolver * the resolver which will be used to translate the URL name - * component to the actual {@link Repository} instance for the + * component to the actual + * {@link org.eclipse.jgit.lib.Repository} instance for the * current web request. */ public RepositoryFilter(final RepositoryResolver resolver) { this.resolver = resolver; } + /** {@inheritDoc} */ @Override public void init(final FilterConfig config) throws ServletException { context = config.getServletContext(); } + /** {@inheritDoc} */ @Override public void destroy() { context = null; } + /** {@inheritDoc} */ @Override public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain chain) diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java index c7fbaf60a7..f1ff547ea7 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java @@ -68,7 +68,9 @@ import org.eclipse.jgit.lib.Constants; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Repository; -/** Common utility functions for servlets. */ +/** + * Common utility functions for servlets. + */ public final class ServletUtils { /** Request attribute which stores the {@link Repository} instance. */ public static final String ATTRIBUTE_REPOSITORY = "org.eclipse.jgit.Repository"; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java index 08a5eba15f..4eb94a3a22 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java @@ -83,6 +83,7 @@ class SmartOutputStream extends TemporaryBuffer { this.compressStream = compressStream; } + /** {@inheritDoc} */ @Override protected OutputStream overflow() throws IOException { startedOutput = true; @@ -95,6 +96,7 @@ class SmartOutputStream extends TemporaryBuffer { return out; } + /** {@inheritDoc} */ @Override public void close() throws IOException { super.close(); diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java index fe34f6691f..6417877e1b 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java @@ -80,16 +80,19 @@ abstract class SmartServiceInfoRefs implements Filter { this.filters = filters.toArray(new Filter[filters.size()]); } + /** {@inheritDoc} */ @Override public void init(FilterConfig config) throws ServletException { // Do nothing. } + /** {@inheritDoc} */ @Override public void destroy() { // Do nothing. } + /** {@inheritDoc} */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { @@ -146,10 +149,31 @@ abstract class SmartServiceInfoRefs implements Filter { } } + /** + * Begin service. + * + * @param req + * request + * @param db + * repository + * @throws IOException + * @throws ServiceNotEnabledException + * @throws ServiceNotAuthorizedException + */ protected abstract void begin(HttpServletRequest req, Repository db) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException; + /** + * Advertise. + * + * @param req + * request + * @param pck + * @throws IOException + * @throws ServiceNotEnabledException + * @throws ServiceNotAuthorizedException + */ protected abstract void advertise(HttpServletRequest req, PacketLineOutRefAdvertiser pck) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java index 28ee17dcd1..00851cfbe4 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java @@ -68,6 +68,7 @@ class TextFileServlet extends HttpServlet { this.fileName = name; } + /** {@inheritDoc} */ @Override public void doGet(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java index 97d00c10a1..3e9c1fefac 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java @@ -164,6 +164,7 @@ class UploadPackServlet extends HttpServlet { } } + /** {@inheritDoc} */ @Override public void doPost(final HttpServletRequest req, final HttpServletResponse rsp) throws IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java index c0a9e0e608..57fdddaf39 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java @@ -50,7 +50,9 @@ import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; -/** Sends a fixed status code to the client. */ +/** + * Send a fixed status code to the client. + */ public class ErrorServlet extends HttpServlet { private static final long serialVersionUID = 1L; @@ -66,6 +68,7 @@ public class ErrorServlet extends HttpServlet { this.status = status; } + /** {@inheritDoc} */ @Override protected void doGet(HttpServletRequest req, HttpServletResponse rsp) throws ServletException, IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java index adb6c425df..43e22b3b30 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java @@ -87,7 +87,9 @@ public class MetaFilter implements Filter { private volatile UrlPipeline[] pipelines; - /** Empty filter with no bindings. */ + /** + * Empty filter with no bindings. + */ public MetaFilter() { this.bindings = new ArrayList<>(); } @@ -128,11 +130,13 @@ public class MetaFilter implements Filter { return register(new RegexPipeline.Binder(pattern)); } + /** {@inheritDoc} */ @Override public void init(FilterConfig filterConfig) throws ServletException { servletContext = filterConfig.getServletContext(); } + /** {@inheritDoc} */ @Override public void destroy() { if (pipelines != null) { @@ -168,6 +172,7 @@ public class MetaFilter implements Filter { }; } + /** {@inheritDoc} */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java index 71365c8f44..d8fa712ebf 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java @@ -74,7 +74,9 @@ public class MetaServlet extends HttpServlet { private final MetaFilter filter; - /** Empty servlet with no bindings. */ + /** + * Empty servlet with no bindings. + */ public MetaServlet() { this(new MetaFilter()); } @@ -89,7 +91,11 @@ public class MetaServlet extends HttpServlet { filter = delegateFilter; } - /** @return filter this servlet delegates all routing logic to. */ + /** + * Get delegate filter + * + * @return filter this servlet delegates all routing logic to. + */ protected MetaFilter getDelegateFilter() { return filter; } @@ -116,6 +122,7 @@ public class MetaServlet extends HttpServlet { return filter.serveRegex(expression); } + /** {@inheritDoc} */ @Override public void init(ServletConfig config) throws ServletException { String name = filter.getClass().getName(); @@ -123,11 +130,13 @@ public class MetaServlet extends HttpServlet { filter.init(new NoParameterFilterConfig(name, ctx)); } + /** {@inheritDoc} */ @Override public void destroy() { filter.destroy(); } + /** {@inheritDoc} */ @Override protected void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java index 961f88e4f8..b4b7455dbf 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java @@ -59,11 +59,13 @@ final class NoParameterFilterConfig implements FilterConfig { this.context = context; } + /** {@inheritDoc} */ @Override public String getInitParameter(String name) { return null; } + /** {@inheritDoc} */ @Override public Enumeration getInitParameterNames() { return new Enumeration() { @@ -79,11 +81,13 @@ final class NoParameterFilterConfig implements FilterConfig { }; } + /** {@inheritDoc} */ @Override public ServletContext getServletContext() { return context; } + /** {@inheritDoc} */ @Override public String getFilterName() { return filterName; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java index a402977ad1..a3dc6c3702 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java @@ -61,14 +61,17 @@ import org.eclipse.jgit.http.server.HttpServerText; * Switch servlet path and path info to use another regex match group. *

* This filter is meant to be installed in the middle of a pipeline created by - * {@link MetaServlet#serveRegex(String)}. The passed request's servlet path is - * updated to be all text up to the start of the designated capture group, and - * the path info is changed to the contents of the capture group. - **/ + * {@link org.eclipse.jgit.http.server.glue.MetaServlet#serveRegex(String)}. The + * passed request's servlet path is updated to be all text up to the start of + * the designated capture group, and the path info is changed to the contents of + * the capture group. + */ public class RegexGroupFilter implements Filter { private final int groupIdx; /** + * Constructor for RegexGroupFilter + * * @param groupIdx * capture group number, 1 through the number of groups. */ @@ -79,16 +82,19 @@ public class RegexGroupFilter implements Filter { this.groupIdx = groupIdx - 1; } + /** {@inheritDoc} */ @Override public void init(FilterConfig config) throws ServletException { // Do nothing. } + /** {@inheritDoc} */ @Override public void destroy() { // Do nothing. } + /** {@inheritDoc} */ @Override public void doFilter(final ServletRequest request, final ServletResponse rsp, final FilterChain chain) diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java index f33243b3b5..bf2d6dbb4d 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java @@ -164,6 +164,7 @@ class RegexPipeline extends UrlPipeline { } } + /** {@inheritDoc} */ @Override public String toString() { return "Pipeline[regex: " + pattern + " ]"; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinder.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinder.java index 47443f5886..b2b4748989 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinder.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinder.java @@ -46,9 +46,13 @@ package org.eclipse.jgit.http.server.glue; import javax.servlet.Filter; import javax.servlet.http.HttpServlet; -/** Binds a servlet to a URL. */ +/** + * Binds a servlet to a URL. + */ public interface ServletBinder { /** + * Set the filter to trigger while processing the path. + * * @param filter * the filter to trigger while processing the path. * @return {@code this}. @@ -56,6 +60,8 @@ public interface ServletBinder { public ServletBinder through(Filter filter); /** + * Set the servlet to execute on this path + * * @param servlet * the servlet to execute on this path. */ diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java index 4e879a9760..18650eb95b 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java @@ -61,6 +61,7 @@ abstract class ServletBinderImpl implements ServletBinder { this.filters = new ArrayList<>(); } + /** {@inheritDoc} */ @Override public ServletBinder through(Filter filter) { if (filter == null) @@ -69,6 +70,7 @@ abstract class ServletBinderImpl implements ServletBinder { return this; } + /** {@inheritDoc} */ @Override public void with(HttpServlet servlet) { if (servlet == null) @@ -78,7 +80,11 @@ abstract class ServletBinderImpl implements ServletBinder { httpServlet = servlet; } - /** @return the configured servlet, or singleton returning 404 if none. */ + /** + * Get the servlet + * + * @return the configured servlet, or singleton returning 404 if none. + */ protected HttpServlet getServlet() { if (httpServlet != null) return httpServlet; @@ -86,7 +92,11 @@ abstract class ServletBinderImpl implements ServletBinder { return new ErrorServlet(HttpServletResponse.SC_NOT_FOUND); } - /** @return the configured filters; zero-length array if none. */ + /** + * Get filters + * + * @return the configured filters; zero-length array if none. + */ protected Filter[] getFilters() { return filters.toArray(new Filter[filters.size()]); } diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java index 903de63b8e..6742c9f721 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java @@ -103,6 +103,7 @@ class SuffixPipeline extends UrlPipeline { super.service(new WrappedRequest(req, newPath, newInfo), rsp); } + /** {@inheritDoc} */ @Override public String toString() { return "Pipeline[ *" + suffix + " ]"; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java index b702c07486..096456866c 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java @@ -46,7 +46,9 @@ package org.eclipse.jgit.http.server.glue; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequestWrapper; -/** Overrides the path and path info. */ +/** + * Overrides the path and path info. + */ public class WrappedRequest extends HttpServletRequestWrapper { private final String path; @@ -69,17 +71,20 @@ public class WrappedRequest extends HttpServletRequestWrapper { this.pathInfo = pathInfo; } + /** {@inheritDoc} */ @Override public String getPathTranslated() { final String p = getPathInfo(); return p != null ? getSession().getServletContext().getRealPath(p) : null; } + /** {@inheritDoc} */ @Override public String getPathInfo() { return pathInfo; } + /** {@inheritDoc} */ @Override public String getServletPath() { return path; diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/AsIsFileService.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/AsIsFileService.java index d20fe9f27a..11ad5e0e1a 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/AsIsFileService.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/AsIsFileService.java @@ -45,7 +45,6 @@ package org.eclipse.jgit.http.server.resolver; import javax.servlet.http.HttpServletRequest; -import org.eclipse.jgit.http.server.GitServlet; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException; @@ -57,8 +56,9 @@ import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException; * Older HTTP clients which do not speak the smart HTTP variant of the Git * protocol fetch from a repository by directly getting its objects and pack * files. This class, along with the {@code http.getanyfile} per-repository - * configuration setting, can be used by {@link GitServlet} to control whether - * or not these older clients are permitted to read these direct files. + * configuration setting, can be used by + * {@link org.eclipse.jgit.http.server.GitServlet} to control whether or not + * these older clients are permitted to read these direct files. */ public class AsIsFileService { /** Always throws {@link ServiceNotEnabledException}. */ @@ -98,8 +98,10 @@ public class AsIsFileService { * throwing a checked exception if access should be denied. *

* The default implementation of this method checks {@code http.getanyfile}, - * throwing {@link ServiceNotEnabledException} if it was explicitly set to - * {@code false}, and otherwise succeeding silently. + * throwing + * {@link org.eclipse.jgit.transport.resolver.ServiceNotEnabledException} if + * it was explicitly set to {@code false}, and otherwise succeeding + * silently. * * @param req * current HTTP request, in case information from the request may diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java index c0ffbb64d7..95eb8d52d7 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java @@ -54,12 +54,14 @@ import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException; import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException; /** - * Create and configure {@link ReceivePack} service instance. + * Create and configure {@link org.eclipse.jgit.transport.ReceivePack} service + * instance. *

* Writing by receive-pack is permitted if any of the following is true: *

@@ -78,6 +80,7 @@ public class DefaultReceivePackFactory implements } } + /** {@inheritDoc} */ @Override public ReceivePack create(final HttpServletRequest req, final Repository db) throws ServiceNotEnabledException, ServiceNotAuthorizedException { diff --git a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java index 642623bdd9..f5afa1ecd0 100644 --- a/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java +++ b/org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java @@ -53,7 +53,8 @@ import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException; import org.eclipse.jgit.transport.resolver.UploadPackFactory; /** - * Create and configure {@link UploadPack} service instance. + * Create and configure {@link org.eclipse.jgit.transport.UploadPack} service + * instance. *

* Reading by upload-pack is permitted unless {@code http.uploadpack} is * explicitly set to false. @@ -68,6 +69,7 @@ public class DefaultUploadPackFactory implements } } + /** {@inheritDoc} */ @Override public UploadPack create(final HttpServletRequest req, final Repository db) throws ServiceNotEnabledException, ServiceNotAuthorizedException { -- 2.39.5