motiejus
/
jgit
1
Fork 0
Code Releases Activity

Fix javadoc in org.eclipse.jgit.http.server 

Change-Id: I732d773b21bbf64285493070964dd9e442eab5d8
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
Matthias Sohn 2017-12-17 00:12:44 +01:00
parent 53891d4eda
commit 3b00041caf
31 changed files with 204 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java
View File

@ -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 {

10
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java
View File

@ -47,13 +47,19 @@
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 };
}

43
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java
View File

@ -62,8 +62,6 @@
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 @@
* Handles Git repository access over HTTP.
* <p>
* 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}.
* <p>
* 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 void setRepositoryResolver(RepositoryResolver<HttpServletRequest> resolve
}
/**
* 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 void setAsIsFileService(AsIsFileService f) {
}
/**
* 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<HttpServletRequest> f) {
@ -146,10 +150,12 @@ public void setUploadPackFactory(UploadPackFactory<HttpServletRequest> 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) {
assertNotInitialized();
@ -157,9 +163,12 @@ public void addUploadPackFilter(Filter filter) {
}
/**
* 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<HttpServletRequest> f) {
@ -168,10 +177,12 @@ public void setReceivePackFactory(ReceivePackFactory<HttpServletRequest> 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) {
assertNotInitialized();
@ -183,6 +194,7 @@ private void assertNotInitialized() {
throw new IllegalStateException(HttpServerText.get().alreadyInitializedByContainer);
}
/** {@inheritDoc} */
@Override
public void init(FilterConfig filterConfig) throws ServletException {
super.init(filterConfig);
@ -297,6 +309,7 @@ private static boolean getBoolean(FilterConfig cfg, String param)
}
}
/** {@inheritDoc} */
@Override
protected ServletBinder register(ServletBinder binder) {
if (resolver == null)

39
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java
View File

@ -54,8 +54,6 @@
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 @@
*
* <p>
* 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 void setRepositoryResolver(RepositoryResolver<HttpServletRequest> resolve
}
/**
* 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 void setAsIsFileService(AsIsFileService f) {
}
/**
* 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<HttpServletRequest> 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<HttpServletRequest> 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() {

4
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitSmartHttpTools.java
View File

@ -154,9 +154,9 @@ public static void sendError(HttpServletRequest req,
* an HTTP response code is returned instead.
* <p>
* 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.

2
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java
View File

@ -52,6 +52,8 @@
public class HttpServerText extends TranslationBundle {
/**
* Get an instance of this translation bundle
*
* @return an instance of this translation bundle
*/
public static HttpServerText get() {

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java
View File

@ -60,6 +60,7 @@
class InfoPacksServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
/** {@inheritDoc} */
@Override
public void doGet(final HttpServletRequest req,
final HttpServletResponse rsp) throws IOException {

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java
View File

@ -64,6 +64,7 @@
class InfoRefsServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
/** {@inheritDoc} */
@Override
public void doGet(final HttpServletRequest req,
final HttpServletResponse rsp) throws IOException {

3
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java
View File

@ -66,16 +66,19 @@
* 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 {

5
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java
View File

@ -57,18 +57,21 @@
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 {

2
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java
View File

@ -117,12 +117,14 @@ static class PackIdx extends PackData {
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 {

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java
View File

@ -165,6 +165,7 @@ public void destroy() {
}
}
/** {@inheritDoc} */
@Override
public void doPost(final HttpServletRequest req,
final HttpServletResponse rsp) throws IOException {

25
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java
View File

@ -71,16 +71,19 @@
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}.
* <p>
* 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.
* <p>
* 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<HttpServletRequest> 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)

4
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java
View File

@ -68,7 +68,9 @@
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";

2
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java
View File

@ -83,6 +83,7 @@ class SmartOutputStream extends TemporaryBuffer {
this.compressStream = compressStream;
}
/** {@inheritDoc} */
@Override
protected OutputStream overflow() throws IOException {
startedOutput = true;
@ -95,6 +96,7 @@ protected OutputStream overflow() throws IOException {
return out;
}
/** {@inheritDoc} */
@Override
public void close() throws IOException {
super.close();

24
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java
View File

@ -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 @@ private void service(ServletRequest request, ServletResponse response)
}
}
/**
* 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;

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java
View File

@ -68,6 +68,7 @@ class TextFileServlet extends HttpServlet {
this.fileName = name;
}
/** {@inheritDoc} */
@Override
public void doGet(final HttpServletRequest req,
final HttpServletResponse rsp) throws IOException {

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java
View File

@ -164,6 +164,7 @@ public void destroy() {
}
}
/** {@inheritDoc} */
@Override
public void doPost(final HttpServletRequest req,
final HttpServletResponse rsp) throws IOException {

5
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java
View File

@ -50,7 +50,9 @@
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 ErrorServlet(final int status) {
this.status = status;
}
/** {@inheritDoc} */
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse rsp)
throws ServletException, IOException {

7
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java
View File

@ -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 ServletBinder serveRegex(Pattern pattern) {
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 int size() {
};
}
/** {@inheritDoc} */
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {

13
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java
View File

@ -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 @@ protected MetaServlet(MetaFilter delegateFilter) {
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 ServletBinder serveRegex(String expression) {
return filter.serveRegex(expression);
}
/** {@inheritDoc} */
@Override
public void init(ServletConfig config) throws ServletException {
String name = filter.getClass().getName();
@ -123,11 +130,13 @@ public void init(ServletConfig config) throws ServletException {
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 {

4
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java
View File

@ -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<String> getInitParameterNames() {
return new Enumeration<String>() {
@ -79,11 +81,13 @@ public String nextElement() {
};
}
/** {@inheritDoc} */
@Override
public ServletContext getServletContext() {
return context;
}
/** {@inheritDoc} */
@Override
public String getFilterName() {
return filterName;

14
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java
View File

@ -61,14 +61,17 @@
* Switch servlet path and path info to use another regex match group.
* <p>
* 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 RegexGroupFilter(final int groupIdx) {
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)

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java
View File

@ -164,6 +164,7 @@ void service(HttpServletRequest req, HttpServletResponse rsp)
}
}
/** {@inheritDoc} */
@Override
public String toString() {
return "Pipeline[regex: " + pattern + " ]";

8
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinder.java
View File

@ -46,9 +46,13 @@
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.
*/

14
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java
View File

@ -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 @@ public ServletBinder through(Filter filter) {
return this;
}
/** {@inheritDoc} */
@Override
public void with(HttpServlet servlet) {
if (servlet == null)
@ -78,7 +80,11 @@ public void with(HttpServlet servlet) {
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 @@ protected HttpServlet getServlet() {
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()]);
}

1
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java
View File

@ -103,6 +103,7 @@ void service(HttpServletRequest req, HttpServletResponse rsp)
super.service(new WrappedRequest(req, newPath, newInfo), rsp);
}
/** {@inheritDoc} */
@Override
public String toString() {
return "Pipeline[ *" + suffix + " ]";

7
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java
View File

@ -46,7 +46,9 @@
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 WrappedRequest(final HttpServletRequest originalRequest,
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;

12
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/AsIsFileService.java
View File

@ -45,7 +45,6 @@
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 @@
* 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 @@ protected static boolean isEnabled(Repository db) {
* throwing a checked exception if access should be denied.
* <p>
* 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

7
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java
View File

@ -54,12 +54,14 @@
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.
* <p>
* Writing by receive-pack is permitted if any of the following is true:
* <ul>
* <li>The container has authenticated the user and set
* {@link HttpServletRequest#getRemoteUser()} to the authenticated name.
* {@link javax.servlet.http.HttpServletRequest#getRemoteUser()} to the
* authenticated name.
* <li>The repository configuration file has {@code http.receivepack} explicitly
* set to true.
* </ul>
@ -78,6 +80,7 @@ private static class ServiceConfig {
}
}
/** {@inheritDoc} */
@Override
public ReceivePack create(final HttpServletRequest req, final Repository db)
throws ServiceNotEnabledException, ServiceNotAuthorizedException {

4
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java
View File

@ -53,7 +53,8 @@
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.
* <p>
* Reading by upload-pack is permitted unless {@code http.uploadpack} is
* explicitly set to false.
@ -68,6 +69,7 @@ private static class ServiceConfig {
}
}
/** {@inheritDoc} */
@Override
public UploadPack create(final HttpServletRequest req, final Repository db)
throws ServiceNotEnabledException, ServiceNotAuthorizedException {