mfcforum: 2015

File Upload and Download and common tasks in a java web application. Since I have written a lot aboutjava servlet recently, I thought to provide a sample example of file upload and download using servlet.

Use Case

Our use case is to provide a simple HTML page where client can select a local file to be uploaded to server. On submission of request to upload the file, our servlet program will upload the file into a directory in the server and then provide the URL through which user can download the file. For security reason, user will not be provided direct URL for downloading the file, rather they will be given a link to download the file and our servlet will process the request and send the file to user.

We will create a dynamic web project in Eclipse and the project structure will look like below image.

Let’s look into all the components of our web application and understand the implementation.

HTML Page for Uploading File

We can upload a file to server by sending a post request to servlet and submitting the form. We can’t use GET method for uploading file.

Another point to note is that enctype of form should be multipart/form-data.

To select a file from user file system, we need to use input element with type as file.

So we can have a simple HTML page for uploading file as:

index.html
<html>

<head></head>

<body>

<form action="UploadDownloadFileServlet" method="post" enctype="multipart/form-data">

Select File to Upload:<input type="file" name="fileName">

<br>

<input type="submit" value="Upload">

</form>

</body>

</html>

index.html
1 2 3 4 5 6 7 8 9 10	`<html>` `<head></head>` `<body>` `<form` `action="UploadDownloadFileServlet"` `method="post"` `enctype="multipart/form-data">` `Select File to Upload:<input` `type="file"` `name="fileName">` `<br>` `<input` `type="submit"` `value="Upload">` `</form>` `</body>` `</html>`

Server File Location

We need to store file into some directory at server, we can have this directory hardcoded in program but for better flexibility, we will keep it configurable in deployment descriptor context params. Also we will add our upload file html page to the welcome file list.

Our web.xml file will look like below:

web.xml
<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">

  <display-name>ServletFileUploadDownloadExample</display-name>

  <welcome-file-list>

    <welcome-file>index.html</welcome-file>

  </welcome-file-list>

  <context-param>

    <param-name>tempfile.dir</param-name>

    <param-value>tmpfiles</param-value>

  </context-param>

</web-app>

web.xml
1 2 3 4 5 6 7 8 9 10 11	`<?xml` `version="1.0"` `encoding="UTF-8"?>` `<web-app` `xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"` `xmlns="http://java.sun.com/xml/ns/javaee"` `xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"` `version="3.0">` `<display-name>ServletFileUploadDownloadExample</display-name>` `<welcome-file-list>` `<welcome-file>index.html</welcome-file>` `</welcome-file-list>` `<context-param>` `<param-name>tempfile.dir</param-name>` `<param-value>tmpfiles</param-value>` `</context-param>` `</web-app>`

ServletContextListener implementation

Since we need to read context parameter for file location and create a File object from it, we can write a ServletContextListener to do it when context is initialized. We can set absolute directory location and File object as context attribute to be used by other servlets.

Our ServletContextListener implementation code is like below.

FileLocationContextListener.java
package com.journaldev.servlet;

import java.io.File;

import javax.servlet.ServletContext;

import javax.servlet.ServletContextEvent;

import javax.servlet.ServletContextListener;

import javax.servlet.annotation.WebListener;

@WebListener

public class FileLocationContextListener implements ServletContextListener {

    public void contextInitialized(ServletContextEvent servletContextEvent) {

        String rootPath = System.getProperty("catalina.home");

        ServletContext ctx = servletContextEvent.getServletContext();

        String relativePath = ctx.getInitParameter("tempfile.dir");

        File file = new File(rootPath + File.separator + relativePath);

        if(!file.exists()) file.mkdirs();

        System.out.println("File Directory created to be used for storing files");

        ctx.setAttribute("FILES_DIR_FILE", file);

        ctx.setAttribute("FILES_DIR", rootPath + File.separator + relativePath);

    }

    public void contextDestroyed(ServletContextEvent servletContextEvent) {

        //do cleanup if needed

    }

}

FileLocationContextListener.java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28	`package` `com.journaldev.servlet;` `import` `java.io.File;` `import` `javax.servlet.ServletContext;` `import` `javax.servlet.ServletContextEvent;` `import` `javax.servlet.ServletContextListener;` `import` `javax.servlet.annotation.WebListener;` `@WebListener` `public` `class` `FileLocationContextListener` `implements` `ServletContextListener {` `public` `void` `contextInitialized(ServletContextEvent servletContextEvent) {` `String rootPath = System.getProperty("catalina.home");` `ServletContext ctx = servletContextEvent.getServletContext();` `String relativePath = ctx.getInitParameter("tempfile.dir");` `File file =` `new` `File(rootPath + File.separator + relativePath);` `if(!file.exists()) file.mkdirs();` `System.out.println("File Directory created to be used for storing files");` `ctx.setAttribute("FILES_DIR_FILE", file);` `ctx.setAttribute("FILES_DIR", rootPath + File.separator + relativePath);` `}` `public` `void` `contextDestroyed(ServletContextEvent servletContextEvent) {` `//do cleanup if needed` `}` `}`

File Upload Download Servlet Implementation

Update: Servlet Specs 3 added support to upload files on server in the API, so we won’t need to use any third party API. Please check out Servlet 3 Upload File.

For File upload, we will use Apache Commons FileUpload utility, for our project we are using version 1.3, FileUpload depends on Apache Commons IO jar, so we need to place both in the lib directory of the project, as you can see that in above image for project structure.

We will use DiskFileItemFactory factory that provides a method to parse the HttpServletRequest object and return list of FileItem. FileItem provides useful method to get the file name, field name in form, size and content type details of the file that needs to be uploaded. To write file to a directory, all we need to do it create a File object and pass it as argument to FileItem write() method.

Since the whole purpose of the servlet is to upload file, we will override init() method to initialize theDiskFileItemFactory object instance of the servlet. We will use this object in the doPost() method implementation to upload file to server directory.

Once the file gets uploaded successfully, we will send response to client with URL to download the file, since HTML links use GET method,we will append the parameter for file name in the URL and we can utilize the same servlet doGet() method to implement file download process.

For implementing download file servlet, first we will open the InputStream for the file and useServletContext.getMimeType() method to get the MIME type of the file and set it as response content type.

We will also need to set the response content length as length of the file. To make sure that client understand that we are sending file in response, we need to set “Content-Disposition” header with value as “attachment; filename=”fileName“.

Once we are done with setting response configuration, we can read file content from InputStream and write it to ServletOutputStream and the flush the output to client.

Our final implementation of UploadDownloadFileServlet servlet looks like below.

UploadDownloadFileServlet.java
package com.journaldev.servlet;

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.PrintWriter;

import java.util.Iterator;

import java.util.List;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.ServletOutputStream;

import javax.servlet.annotation.WebServlet;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.commons.fileupload.FileItem;

import org.apache.commons.fileupload.FileUploadException;

import org.apache.commons.fileupload.disk.DiskFileItemFactory;

import org.apache.commons.fileupload.servlet.ServletFileUpload;

@WebServlet("/UploadDownloadFileServlet")

public class UploadDownloadFileServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    private ServletFileUpload uploader = null;

    @Override

    public void init() throws ServletException{

        DiskFileItemFactory fileFactory = new DiskFileItemFactory();

        File filesDir = (File) getServletContext().getAttribute("FILES_DIR_FILE");

        fileFactory.setRepository(filesDir);

        this.uploader = new ServletFileUpload(fileFactory);

    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        String fileName = request.getParameter("fileName");

        if(fileName == null || fileName.equals("")){

            throw new ServletException("File Name can't be null or empty");

        }

        File file = new File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileName);

        if(!file.exists()){

            throw new ServletException("File doesn't exists on server.");

        }

        System.out.println("File location on server::"+file.getAbsolutePath());

        ServletContext ctx = getServletContext();

        InputStream fis = new FileInputStream(file);

        String mimeType = ctx.getMimeType(file.getAbsolutePath());

        response.setContentType(mimeType != null? mimeType:"application/octet-stream");

        response.setContentLength((int) file.length());

        response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");

        ServletOutputStream os       = response.getOutputStream();

        byte[] bufferData = new byte[1024];

        int read=0;

        while((read = fis.read(bufferData))!= -1){

            os.write(bufferData, 0, read);

        }

        os.flush();

        os.close();

        fis.close();

        System.out.println("File downloaded at client successfully");

    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        if(!ServletFileUpload.isMultipartContent(request)){

            throw new ServletException("Content type is not multipart/form-data");

        }

        response.setContentType("text/html");

        PrintWriter out = response.getWriter();

        out.write("<html><head></head><body>");

        try {

            List<FileItem> fileItemsList = uploader.parseRequest(request);

            Iterator<FileItem> fileItemsIterator = fileItemsList.iterator();

            while(fileItemsIterator.hasNext()){

                FileItem fileItem = fileItemsIterator.next();

                System.out.println("FieldName="+fileItem.getFieldName());

                System.out.println("FileName="+fileItem.getName());

                System.out.println("ContentType="+fileItem.getContentType());

                System.out.println("Size in bytes="+fileItem.getSize());

                File file = new File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileItem.getName());

                System.out.println("Absolute Path at server="+file.getAbsolutePath());

                fileItem.write(file);

                out.write("File "+fileItem.getName()+ " uploaded successfully.");

                out.write("<br>");

                out.write("<a href=\"UploadDownloadFileServlet?fileName="+fileItem.getName()+"\">Download "+fileItem.getName()+"</a>");

            }

        } catch (FileUploadException e) {

            out.write("Exception in uploading file.");

        } catch (Exception e) {

            out.write("Exception in uploading file.");

        }

        out.write("</body></html>");

    }

}

UploadDownloadFileServlet.java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97	`package` `com.journaldev.servlet;` `import` `java.io.File;` `import` `java.io.FileInputStream;` `import` `java.io.IOException;` `import` `java.io.InputStream;` `import` `java.io.PrintWriter;` `import` `java.util.Iterator;` `import` `java.util.List;` `import` `javax.servlet.ServletContext;` `import` `javax.servlet.ServletException;` `import` `javax.servlet.ServletOutputStream;` `import` `javax.servlet.annotation.WebServlet;` `import` `javax.servlet.http.HttpServlet;` `import` `javax.servlet.http.HttpServletRequest;` `import` `javax.servlet.http.HttpServletResponse;` `import` `org.apache.commons.fileupload.FileItem;` `import` `org.apache.commons.fileupload.FileUploadException;` `import` `org.apache.commons.fileupload.disk.DiskFileItemFactory;` `import` `org.apache.commons.fileupload.servlet.ServletFileUpload;` `@WebServlet("/UploadDownloadFileServlet")` `public` `class` `UploadDownloadFileServlet` `extends` `HttpServlet {` `private` `static` `final` `long` `serialVersionUID = 1L;` `private` `ServletFileUpload uploader =` `null;` `@Override` `public` `void` `init()` `throws` `ServletException{` `DiskFileItemFactory fileFactory =` `new` `DiskFileItemFactory();` `File filesDir = (File) getServletContext().getAttribute("FILES_DIR_FILE");` `fileFactory.setRepository(filesDir);` `this.uploader =` `new` `ServletFileUpload(fileFactory);` `}` `protected` `void` `doGet(HttpServletRequest request, HttpServletResponse response)` `throws` `ServletException, IOException {` `String fileName = request.getParameter("fileName");` `if(fileName ==` `null` `\|\| fileName.equals("")){` `throw` `new` `ServletException("File Name can't be null or empty");` `}` `File file =` `new` `File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileName);` `if(!file.exists()){` `throw` `new` `ServletException("File doesn't exists on server.");` `}` `System.out.println("File location on server::"+file.getAbsolutePath());` `ServletContext ctx = getServletContext();` `InputStream fis =` `new` `FileInputStream(file);` `String mimeType = ctx.getMimeType(file.getAbsolutePath());` `response.setContentType(mimeType !=` `null? mimeType:"application/octet-stream");` `response.setContentLength((int) file.length());` `response.setHeader("Content-Disposition",` `"attachment; filename=\""` `+ fileName +` `"\"");` `ServletOutputStream os = response.getOutputStream();` `byte[] bufferData =` `new` `byte[1024];` `int` `read=0;` `while((read = fis.read(bufferData))!= -1){` `os.write(bufferData,` `0, read);` `}` `os.flush();` `os.close();` `fis.close();` `System.out.println("File downloaded at client successfully");` `}` `protected` `void` `doPost(HttpServletRequest request, HttpServletResponse response)` `throws` `ServletException, IOException {` `if(!ServletFileUpload.isMultipartContent(request)){` `throw` `new` `ServletException("Content type is not multipart/form-data");` `}` `response.setContentType("text/html");` `PrintWriter out = response.getWriter();` `out.write("<html><head></head><body>");` `try` `{` `List<FileItem> fileItemsList = uploader.parseRequest(request);` `Iterator<FileItem> fileItemsIterator = fileItemsList.iterator();` `while(fileItemsIterator.hasNext()){` `FileItem fileItem = fileItemsIterator.next();` `System.out.println("FieldName="+fileItem.getFieldName());` `System.out.println("FileName="+fileItem.getName());` `System.out.println("ContentType="+fileItem.getContentType());` `System.out.println("Size in bytes="+fileItem.getSize());` `File file =` `new` `File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileItem.getName());` `System.out.println("Absolute Path at server="+file.getAbsolutePath());` `fileItem.write(file);` `out.write("File "+fileItem.getName()+` `" uploaded successfully.");` `out.write("<br>");` `out.write("<a href=\"UploadDownloadFileServlet?fileName="+fileItem.getName()+"\">Download "+fileItem.getName()+"</a>");` `}` `}` `catch` `(FileUploadException e) {` `out.write("Exception in uploading file.");` `}` `catch` `(Exception e) {` `out.write("Exception in uploading file.");` `}` `out.write("</body></html>");` `}` `}`