Package me.desair.tus.server.util

Class TusServletRequest

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
me.desair.tus.server.util.TusServletRequest
All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
public class TusServletRequest extends jakarta.servlet.http.HttpServletRequestWrapper

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletRequest

    BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  • Constructor Summary

    Constructors
    Constructor
    Description
    TusServletRequest(jakarta.servlet.http.HttpServletRequest request)
    Constructs a request object wrapping the given request.
    TusServletRequest(jakarta.servlet.http.HttpServletRequest request, boolean isChunkedTransferDecodingEnabled)
    Constructs a request object wrapping the given request.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addProcessor(TusExtension processor)
     
    long
    getBytesRead()
     
    String
    getCalculatedChecksum(ChecksumAlgorithm algorithm)
     
    InputStream
    getContentInputStream()
     
    Set<ChecksumAlgorithm>
    getEnabledChecksums()
    Get the set of checksum algorithms that are actively calculated within this request
    String
    getHeader(String name)
     
    boolean
    hasCalculatedChecksum()
     
    boolean
    isProcessedBy(TusExtension processor)
     

    Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

    authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

    Methods inherited from class jakarta.servlet.ServletRequestWrapper

    getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface jakarta.servlet.ServletRequest

    getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

  • Constructor Details

    • TusServletRequest

      public TusServletRequest(jakarta.servlet.http.HttpServletRequest request, boolean isChunkedTransferDecodingEnabled)
      Constructs a request object wrapping the given request.
      Parameters:
      request - The upload request we need to wrap
      isChunkedTransferDecodingEnabled - Should this request wrapper decode a chunked input stream
      Throws:
      IllegalArgumentException - if the request is null

    • TusServletRequest

      public TusServletRequest(jakarta.servlet.http.HttpServletRequest request)
      Constructs a request object wrapping the given request.
      Parameters:
      request - The upload request we need to wrap
      Throws:
      IllegalArgumentException - if the request is null

  • Method Details

    • getContentInputStream

      public InputStream getContentInputStream() throws IOException
      Throws:
      IOException

    • getBytesRead

      public long getBytesRead()

    • hasCalculatedChecksum

      public boolean hasCalculatedChecksum()

    • getCalculatedChecksum

      public String getCalculatedChecksum(ChecksumAlgorithm algorithm)

    • getEnabledChecksums

      public Set<ChecksumAlgorithm> getEnabledChecksums()
      Get the set of checksum algorithms that are actively calculated within this request
      Returns:
      The set of active checksum algorithms

    • getHeader

      public String getHeader(String name)
      Specified by:
      getHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • isProcessedBy

      public boolean isProcessedBy(TusExtension processor)

    • addProcessor

      public void addProcessor(TusExtension processor)