Struts File Upload Tutorial

In this tutorial we will see how to allow the user to upload a file using Struts. In order to allow the user to upload a file, we need to set the encoding type of html:form tag to "multipart/form-data" and specify the HTTP method as "post". The html:file tag enables the user to browse and select a file.

<html:form action="fileUploadAction" method="post" enctype="multipart/form-data">
    File : <html:file property="file" /> <br/>
    <html:submit />
</html:form>

The property file in the FileUploadForm is of type FormFile (org.apache.struts.upload.FormFile). We will check whether the file uploaded by the user satisfies the following conditions in the FileUploadForm's validate() method.

• Should be an Excel File.
• File size should not exceed 20kb.
  

The validate() method of the FileUploadForm contains the following code.

public ActionErrors validate(ActionMapping mapping, HttpServletRequest request) {
    ActionErrors errors = new ActionErrors();
    if (file.getFileSize() == 0) {
    	errors.add("file", new ActionMessage("error.file.required"));
    } else if (!file.getContentType().equals("application/vnd.ms-excel")) {
    	errors.add("file", new ActionMessage("error.file.type"));
    }
    /**
    * If the file size is greater than 20kb.
    */
    else if (file.getFileSize() > 20480) {
    	errors.add("file", new ActionMessage("error.file.size"));
    }
    return errors;
}

The getFileSize() method returns the size of the file. The getContentType() method returns the content type of the file selected by the user.

We save the file uploaded by the user in the server. To do this we first get the file uploaded by the user using the getFile() method. The getFile() mehtod returns a FormFile object. Using the FormFile object we can get details regarding the file like file name and file data.

The FileUploadAction contains the following code.

public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
  FileUploadForm uploadForm = (FileUploadForm) form;
  FileOutputStream outputStream = null;
  FormFile formFile = null;
  try {
      formFile = uploadForm.getFile();
      String path = getServlet().getServletContext().getRealPath("")+"/"+
      formFile.getFileName();
      outputStream = new FileOutputStream(new File(path));
      outputStream.write(formFile.getFileData());
  } 
  finally {
      if (outputStream != null) {
          outputStream.close();
      }
  }
uploadForm.setMessage("The file "+formFile.getFileName()+" is uploaded successfully.");
return mapping.findForward(SUCCESS);
}

The getFileData() method returns the entire file as a byte[]. This method should be used only when the file size is small, incase of large files its better to use getInputStream() method.

On executing the example the following page will be displayed to the user.

When the user submits the form without selecting any file the following message is dispalyed to the user.

When the user selects a file other than an Excel file then the following message is dispalyed to the user.

When the user selects a file that is greater than 20kb then the following message is dispalyed to the user.

When the user selects an excel file that is less than 20kb, then the user is forwarded to the success page.

• Download the example and copy it inside the webapps directory of the Tomcat sever.
• Run the example using the following url "http://localhost:8080/Example23/".
• Select an excel file to upload.
• The excel file will be saved inside the Example directory in the server.
• For example, when I uploaded the temp.xls file the file got stored in the following location "C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps\Example23\temp.xls".

You can download the source code of the File Upload example by clicking on the Download link below.

Source :Download

Source + Lib :Download