Package org.eclipse.jgit.http.server

Class GitFilter

  • All Implemented Interfaces:
    javax.servlet.Filter
    public class GitFilter
extends MetaFilter
    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 GitServlet.

    Applications may wish to add additional repository action URLs to this servlet by taking advantage of its extension from MetaFilter. Callers may register their own URL suffix translations through MetaFilter.serve(String), or their regex translations through MetaFilter.serveRegex(String). Each translation should contain a complete filter pipeline which ends with the HttpServlet that should handle the requested action.

    • Field Detail

      • initialized

        private volatile boolean initialized

      • uploadPackFactory

        private UploadPackFactory<javax.servlet.http.HttpServletRequest> uploadPackFactory

      • receivePackFactory

        private ReceivePackFactory<javax.servlet.http.HttpServletRequest> receivePackFactory

      • uploadPackFilters

        private final java.util.List<javax.servlet.Filter> uploadPackFilters

      • receivePackFilters

        private final java.util.List<javax.servlet.Filter> receivePackFilters

    • Constructor Detail

      • GitFilter

        public GitFilter()
        New servlet that will load its base directory from web.xml.

        The required parameter base-path must be configured to point to the local filesystem directory where all served Git repositories reside.

    • Method Detail

      • setRepositoryResolver

        public void setRepositoryResolver​(RepositoryResolver<javax.servlet.http.HttpServletRequest> resolver)
        New servlet configured with a specific resolver.
        Parameters:
        resolver - the resolver to use when matching URL to Git repository. If null the base-path parameter will be looked for in the parameter table during init, which usually comes from the web.xml file of the web application.

      • setAsIsFileService

        public void setAsIsFileService​(AsIsFileService f)
        Set AsIsFileService
        Parameters:
        f - the filter to validate direct access to repository files through a dumb client. If null then dumb client support is completely disabled.

      • setUploadPackFactory

        public void setUploadPackFactory​(UploadPackFactory<javax.servlet.http.HttpServletRequest> f)
        Set upload-pack factory
        Parameters:
        f - the factory to construct and configure an UploadPack session when a fetch or clone is requested by a client.

      • setUploadPackErrorHandler

        public void setUploadPackErrorHandler​(UploadPackErrorHandler h)
        Set a custom error handler for git-upload-pack.
        Parameters:
        h - A custom error handler for git-upload-pack.

      • addUploadPackFilter

        public void addUploadPackFilter​(javax.servlet.Filter filter)
        Add upload-pack filter
        Parameters:
        filter - filter to apply before any of the UploadPack operations. The UploadPack instance is available in the request attribute ServletUtils.ATTRIBUTE_HANDLER.

      • setReceivePackFactory

        public void setReceivePackFactory​(ReceivePackFactory<javax.servlet.http.HttpServletRequest> f)
        Set the receive-pack factory
        Parameters:
        f - the factory to construct and configure a ReceivePack session when a push is requested by a client.

      • setReceivePackErrorHandler

        public void setReceivePackErrorHandler​(ReceivePackErrorHandler h)
        Set a custom error handler for git-receive-pack.
        Parameters:
        h - A custom error handler for git-receive-pack.

      • addReceivePackFilter

        public void addReceivePackFilter​(javax.servlet.Filter filter)
        Add receive-pack filter
        Parameters:
        filter - filter to apply before any of the ReceivePack operations. The ReceivePack instance is available in the request attribute ServletUtils.ATTRIBUTE_HANDLER.

      • assertNotInitialized

        private void assertNotInitialized()

      • init

        public void init​(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException
        Specified by:
        init in interface javax.servlet.Filter
        Overrides:
        init in class MetaFilter
        Throws:
        javax.servlet.ServletException

      • getFile

        private static java.io.File getFile​(javax.servlet.FilterConfig cfg,
                                    java.lang.String param)
                             throws javax.servlet.ServletException
        Throws:
        javax.servlet.ServletException

      • getBoolean

        private static boolean getBoolean​(javax.servlet.FilterConfig cfg,
                                  java.lang.String param)
                           throws javax.servlet.ServletException
        Throws:
        javax.servlet.ServletException

      • register

        protected ServletBinder register​(ServletBinder binder)
        Configure a newly created binder.
        Overrides:
        register in class MetaFilter
        Parameters:
        binder - the newly created binder.
        Returns:
        binder for the caller, potentially after adding one or more filters into the pipeline.