Apache Commons logo Commons FileUpload

CPD Results

The following document contains the results of PMD's CPD 6.55.0.

Duplications

File Project Line
org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletFileUpload.java Apache Commons FileUpload Jakarta Servlet 5 45
org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletFileUpload.java Apache Commons FileUpload Jakarta Servlet 6 45
public class JakartaServletFileUpload<I extends FileItem<I>, F extends FileItemFactory<I>> extends AbstractFileUpload<HttpServletRequest, I, F> {

    /**
     * Constant for HTTP POST method.
     */
    private static final String POST_METHOD = "POST";

    /**
     * Tests whether the request contains multipart content.
     *
     * @param request The servlet request to be evaluated. Must be non-null.
     *
     * @return {@code true} if the request is multipart; {@code false} otherwise.
     */
    public static final boolean isMultipartContent(final HttpServletRequest request) {
        return POST_METHOD.equalsIgnoreCase(request.getMethod()) && AbstractFileUpload.isMultipartContent(new JakartaServletRequestContext(request));
    }

    /**
     * Constructs an uninitialized instance of this class. A factory must be configured, using {@code setFileItemFactory()}, before attempting to parse
     * requests.
     *
     * @see AbstractFileUpload#AbstractFileUpload()
     */
    public JakartaServletFileUpload() {
    }

    /**
     * Constructs an instance of this class which uses the supplied factory to create {@code FileItem} instances.
     *
     * @see AbstractFileUpload#AbstractFileUpload()
     * @param fileItemFactory The factory to use for creating file items.
     */
    public JakartaServletFileUpload(final F fileItemFactory) {
        setFileItemFactory(fileItemFactory);
    }

    /**
     * Gets an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant {@code multipart/form-data} file item iterator.
     *
     * @param request The servlet request to be parsed.
     * @return An iterator to instances of {@code FileItemInput} parsed from the request, in the order that they were transmitted.
     * @throws FileUploadException if there are problems reading/parsing the request or storing files.
     * @throws IOException         An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the
     *                             uploaded content.
     */
    @Override
    public FileItemInputIterator getItemIterator(final HttpServletRequest request) throws FileUploadException, IOException {
        return super.getItemIterator(new JakartaServletRequestContext(request));
    }

    /**
     * Parses an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant {@code multipart/form-data} stream.
     *
     * @param request The servlet request to be parsed.
     * @return A map of {@code FileItem} instances parsed from the request.
     * @throws FileUploadException if there are problems reading/parsing the request or storing files.
     */
    @Override
    public Map<String, List<I>> parseParameterMap(final HttpServletRequest request) throws FileUploadException {
        return parseParameterMap(new JakartaServletRequestContext(request));
    }

    /**
     * Parses an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant {@code multipart/form-data} stream.
     *
     * @param request The servlet request to be parsed.
     * @return A list of {@code FileItem} instances parsed from the request, in the order that they were transmitted.
     * @throws FileUploadException if there are problems reading/parsing the request or storing files.
     */
    @Override
    public List<I> parseRequest(final HttpServletRequest request) throws FileUploadException {
        return parseRequest(new JakartaServletRequestContext(request));
    }

}
File Project Line
org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileCleaner.java Apache Commons FileUpload Jakarta Servlet 5 28
org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileCleaner.java Apache Commons FileUpload Jakarta Servlet 6 28
public class JakartaFileCleaner implements ServletContextListener {

    /**
     * Attribute name, which is used for storing an instance of {@link FileCleaningTracker} in the web application.
     */
    public static final String FILE_CLEANING_TRACKER_ATTRIBUTE = JakartaFileCleaner.class.getName() + ".FileCleaningTracker";

    /**
     * Gets the instance of {@link FileCleaningTracker}, which is associated with the given {@link ServletContext}.
     *
     * @param servletContext The servlet context to query
     * @return The contexts tracker
     */
    public static FileCleaningTracker getFileCleaningTracker(final ServletContext servletContext) {
        return (FileCleaningTracker) servletContext.getAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE);
    }

    /**
     * Sets the instance of {@link FileCleaningTracker}, which is associated with the given {@link ServletContext}.
     *
     * @param servletContext The servlet context to modify
     * @param tracker        The tracker to set
     */
    public static void setFileCleaningTracker(final ServletContext servletContext, final FileCleaningTracker tracker) {
        servletContext.setAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE, tracker);
    }

    /**
     * Called when the web application is being destroyed. Calls {@link FileCleaningTracker#exitWhenFinished()}.
     *
     * @param sce The servlet context, used for calling {@link #getFileCleaningTracker(ServletContext)}.
     */
    @Override
    public void contextDestroyed(final ServletContextEvent sce) {
        getFileCleaningTracker(sce.getServletContext()).exitWhenFinished();
    }

    /**
     * Called when the web application is initialized. Does nothing.
     *
     * @param sce The servlet context, used for calling {@link #setFileCleaningTracker(ServletContext, FileCleaningTracker)}.
     */
    @Override
    public void contextInitialized(final ServletContextEvent sce) {
        setFileCleaningTracker(sce.getServletContext(), new FileCleaningTracker());
    }
}
File Project Line
org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileCleaner.java Apache Commons FileUpload Jakarta Servlet 5 33
org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileCleaner.java Apache Commons FileUpload Jakarta Servlet 6 33
org/apache/commons/fileupload2/javax/JavaxFileCleaner.java Apache Commons FileUpload Javax 33
public static final String FILE_CLEANING_TRACKER_ATTRIBUTE = JakartaFileCleaner.class.getName() + ".FileCleaningTracker";

    /**
     * Gets the instance of {@link FileCleaningTracker}, which is associated with the given {@link ServletContext}.
     *
     * @param servletContext The servlet context to query
     * @return The contexts tracker
     */
    public static FileCleaningTracker getFileCleaningTracker(final ServletContext servletContext) {
        return (FileCleaningTracker) servletContext.getAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE);
    }

    /**
     * Sets the instance of {@link FileCleaningTracker}, which is associated with the given {@link ServletContext}.
     *
     * @param servletContext The servlet context to modify
     * @param tracker        The tracker to set
     */
    public static void setFileCleaningTracker(final ServletContext servletContext, final FileCleaningTracker tracker) {
        servletContext.setAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE, tracker);
    }

    /**
     * Called when the web application is being destroyed. Calls {@link FileCleaningTracker#exitWhenFinished()}.
     *
     * @param sce The servlet context, used for calling {@link #getFileCleaningTracker(ServletContext)}.
     */
    @Override
    public void contextDestroyed(final ServletContextEvent sce) {
        getFileCleaningTracker(sce.getServletContext()).exitWhenFinished();
    }

    /**
     * Called when the web application is initialized. Does nothing.
     *
     * @param sce The servlet context, used for calling {@link #setFileCleaningTracker(ServletContext, FileCleaningTracker)}.
     */
    @Override
    public void contextInitialized(final ServletContextEvent sce) {
        setFileCleaningTracker(sce.getServletContext(), new FileCleaningTracker());
    }
}