Package com.twelvemonkeys.servlet.fileupload

Interface HttpFileUploadRequest

  • All Superinterfaces:
    javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
    public interface HttpFileUploadRequest
extends javax.servlet.http.HttpServletRequest
    This interface represents an HTTP file upload request, as specified by Form-based File Upload in HTML (RFC1867).
    Version:
    $Id: HttpFileUploadRequest.java#1 $
    Author:
    Harald Kuhr

    • Field Summary

      • Fields inherited from interface javax.servlet.http.HttpServletRequest

        BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      UploadedFile getUploadedFile​(java.lang.String pName)
      Returns the value of a request parameter as an UploadedFile, or null if the parameter does not exist.
      UploadedFile[] getUploadedFiles​(java.lang.String pName)
      Returns an array of UploadedFile objects containing all the values for the given request parameter, or null if the parameter does not exist.

      • Methods inherited from interface javax.servlet.http.HttpServletRequest

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

      • Methods inherited from interface javax.servlet.ServletRequest

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

    • Method Detail

      • getUploadedFile

        UploadedFile getUploadedFile​(java.lang.String pName)
        Returns the value of a request parameter as an UploadedFile, or null if the parameter does not exist. You should only use this method when you are sure the parameter has only one value.
        Parameters:
        pName - the name of the requested parameter
        Returns:
        a UoploadedFile or null
        See Also:
        getUploadedFiles(String)

      • getUploadedFiles

        UploadedFile[] getUploadedFiles​(java.lang.String pName)
        Returns an array of UploadedFile objects containing all the values for the given request parameter, or null if the parameter does not exist.
        Parameters:
        pName - the name of the requested parameter
        Returns:
        an array of UoploadedFiles or null