Class LfsProtocolServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.eclipse.jgit.lfs.server.LfsProtocolServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
public abstract class LfsProtocolServlet extends javax.servlet.http.HttpServlet
LFS protocol handler implementing the LFS batch API [1] [1] https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md
Since:
4.3
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    LfsProtocolServlet.LfsRequest
    LFS request.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LfsProtocolServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    protected abstract LargeFileRepository
    getLargeFileRepository(LfsProtocolServlet.LfsRequest request, String path, String auth)
    Get the large file repository for the given request and path.

    Methods inherited from class javax.servlet.http.HttpServlet

    doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

    Methods inherited from class javax.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

    Methods inherited from class Object

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

  • Constructor Details

    • LfsProtocolServlet

      public LfsProtocolServlet()

  • Method Details

    • getLargeFileRepository

      protected abstract LargeFileRepository getLargeFileRepository(LfsProtocolServlet.LfsRequest request, String path, String auth) throws LfsException
      Get the large file repository for the given request and path.
      Parameters:
      request - the request
      path - the path
      auth - the Authorization HTTP header
      Returns:
      the large file repository storing large files.
      Throws:
      LfsException - implementations should throw more specific exceptions to signal which type of error occurred:
      LfsValidationError
      when there is a validation error with one or more of the objects in the request
      LfsRepositoryNotFound
      when the repository does not exist for the user
      LfsRepositoryReadOnly
      when the user has read, but not write access. Only applicable when the operation in the request is "upload"
      LfsRateLimitExceeded
      when the user has hit a rate limit with the server
      LfsBandwidthLimitExceeded
      when the bandwidth limit for the user or repository has been exceeded
      LfsInsufficientStorage
      when there is insufficient storage on the server
      LfsUnavailable
      when LFS is not available
      LfsException
      when an unexpected internal server error occurred
      Since:
      4.7

    • doPost

      protected void doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) throws javax.servlet.ServletException, IOException
      Overrides:
      doPost in class javax.servlet.http.HttpServlet
      Throws:
      javax.servlet.ServletException
      IOException