org.eclipse.jgit.http.server

Class GitFilter

java.lang.Object

org.eclipse.jgit.http.server.glue.MetaFilter

org.eclipse.jgit.http.server.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.

Constructor Summary

Constructors

Constructor and Description
GitFilter() New servlet that will load its base directory from web.xml.

Method Summary

Modifier and Type	Method and Description
void	addReceivePackFilter(javax.servlet.Filter filter) Add receive-pack filter
void	addUploadPackFilter(javax.servlet.Filter filter) Add upload-pack filter
void	init(javax.servlet.FilterConfig filterConfig)
protected ServletBinder	register(ServletBinder binder) Configure a newly created binder.
void	setAsIsFileService(AsIsFileService f) Set AsIsFileService
void	setReceivePackFactory(ReceivePackFactory<javax.servlet.http.HttpServletRequest> f) Set the receive-pack factory
void	setRepositoryResolver(RepositoryResolver<javax.servlet.http.HttpServletRequest> resolver) New servlet configured with a specific resolver.
void	setUploadPackFactory(UploadPackFactory<javax.servlet.http.HttpServletRequest> f) Set upload-pack factory

Methods inherited from class org.eclipse.jgit.http.server.glue.MetaFilter

destroy, doFilter, serve, serveRegex, serveRegex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

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.

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.

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

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.