File Uploading in Servlets

Last updated on May 31 2022
Vivek Saxena

Table of Contents

File Uploading in Servlets

A Servlet can be used with an HTML form tag to allow users to upload files to the server. An uploaded file could be a text file or image file or any document.

Creating a File Upload Form

The following HTM code below creates an uploader form. Following are the important points to be noted down −

  • The form method attribute should be set to POST method and GET method can not be used
  • The form enctype attribute should be set to multipart/form-data.
  • The form action attribute should be set to a servlet file which would handle file uploading at backend server. Following example is using UploadServlet servlet to upload file.
  • To upload a single file you should use a single <input …/> tag with attribute type=”file”. To allow multiple files uploading, include more than one input tags with different values for the name attribute. The browser associates a Browse button with each of them.
<html>

   <head>

      <title>File Uploading Form</title>

   </head>

  

   <body>

      <h3>File Upload:</h3>

      Select a file to upload: <br />

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

         <input type = "file" name = "file" size = "50" />

         <br />

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

      </form>

   </body>

</html>

This will display following result which would allow to select a file from local PC and when user would click at “Upload File”, form would be submitted along with the selected fil −

 

File Upload:

Select a file to upload:

NOTE: This is just dummy form and would not work.

Writing Backend Servlet

Following is the servlet UploadServlet which would take care of accepting uploaded file and to store it in directory <Tomcat-installation-directory>/webapps/data. This directory name could also be added using an external configuration such as a context-param element in web.xml as follows −


<web-app>

   ....

   <context-param>

      <description>Location to store uploaded file</description>

      <param-name>file-upload</param-name>

      <param-value>

         c:\apache-tomcat-5.5.29\webapps\data\

     </param-value>

   </context-param>

   ....

</web-app>

Following is the source code for UploadServlet which can handle multiple file uploading at a time. Before proceeding you have make sure the followings −

  • Following example depends on FileUpload, so make sure you have the latest version of commons-fileupload.x.x.jar file in your classpath. You can download it from https://commons.apache.org/fileupload/.
  • FileUpload depends on Commons IO, so make sure you have the latest version of commons-io-x.x.jar file in your classpath. You can download it from https://commons.apache.org/io/.
  • While testing following example, you should upload a file which has less size than maxFileSize otherwise file would not be uploaded.
  • Make sure you have created directories c:\temp and c:\apache-tomcat8.0.28\webapps\data well in advance.
// Import required java libraries

import java.io.*;

import java.util.*;




import javax.servlet.ServletConfig;

import javax.servlet.ServletException;

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;

import org.apache.commons.io.output.*;




public class UploadServlet extends HttpServlet {

  

   private boolean isMultipart;

   private String filePath;

   private int maxFileSize = 50 * 1024;

   private int maxMemSize = 4 * 1024;

   private File file ;




   public void init( ){

      // Get the file location where it would be stored.

      filePath = getServletContext().getInitParameter("file-upload");

   }

  

   public void doPost(HttpServletRequest request, HttpServletResponse response)

      throws ServletException, java.io.IOException {

  

      // Check that we have a file upload request

      isMultipart = ServletFileUpload.isMultipartContent(request);

      response.setContentType("text/html");

      java.io.PrintWriter out = response.getWriter( );

  

      if( !isMultipart ) {

         out.println("<html>");

         out.println("<head>");

         out.println("<title>Servlet upload</title>"); 

         out.println("</head>");

         out.println("<body>");

         out.println("<p>No file uploaded</p>");

         out.println("</body>");

         out.println("</html>");

         return;

      }




      DiskFileItemFactory factory = new DiskFileItemFactory();

  

      // maximum size that will be stored in memory

      factory.setSizeThreshold(maxMemSize);

  

      // Location to save data that is larger than maxMemSize.

      factory.setRepository(new File("c:\\temp"));




      // Create a new file upload handler

      ServletFileUpload upload = new ServletFileUpload(factory);

  

      // maximum file size to be uploaded.

      upload.setSizeMax( maxFileSize );




      try {

         // Parse the request to get file items.

         List fileItems = upload.parseRequest(request);

              

         // Process the uploaded file items

         Iterator i = fileItems.iterator();




         out.println("<html>");

         out.println("<head>");

         out.println("<title>Servlet upload</title>"); 

         out.println("</head>");

         out.println("<body>");

  

         while ( i.hasNext () ) {

            FileItem fi = (FileItem)i.next();

            if ( !fi.isFormField () ) {

               // Get the uploaded file parameters

               String fieldName = fi.getFieldName();

               String fileName = fi.getName();

               String contentType = fi.getContentType();

               boolean isInMemory = fi.isInMemory();

               long sizeInBytes = fi.getSize();

           

               // Write the file

               if( fileName.lastIndexOf("\\") >= 0 ) {

                  file = new File( filePath + fileName.substring( fileName.lastIndexOf("\\"))) ;

               } else {

                  file = new File( filePath + fileName.substring(fileName.lastIndexOf("\\")+1)) ;

               }

               fi.write( file ) ;

               out.println("Uploaded Filename: " + fileName + "<br>");

            }

         }

         out.println("</body>");

         out.println("</html>");

         } catch(Exception ex) {

            System.out.println(ex);

         }

      }

     

      public void doGet(HttpServletRequest request, HttpServletResponse response)

         throws ServletException, java.io.IOException {




         throw new ServletException("GET method used with " +

            getClass( ).getName( )+": POST method required.");

      }

   }

}

Compile and Running Servlet

Compile above servlet UploadServlet and create required entry in web.xml file as follows.

 

<servlet>

   <servlet-name>UploadServlet</servlet-name>

   <servlet-class>UploadServlet</servlet-class>

</servlet>




<servlet-mapping>

   <servlet-name>UploadServlet</servlet-name>

   <url-pattern>/UploadServlet</url-pattern>

</servlet-mapping>

Now try to upload files using the HTML form which you created above. When you would try http://localhost:8080/UploadFile.htm, it would display following result which would help you uploading any file from your local machine.

 

File Upload:

Select a file to upload:

 

If your servlet script works fine, your file should be uploaded in c:\apache-tomcat8.0.28\webapps\data\ directory.

 

So, this brings us to the end of blog. This Tecklearn ‘File Uploading in Servlets’ blog helps you with commonly asked questions if you are looking out for a job in Java Programming. If you wish to learn Servlets and build a career Java Programming domain, then check out our interactive, Java and JEE Training, that comes with 24*7 support to guide you throughout your learning period. Please find the link for course details:

https://www.tecklearn.com/course/java-and-jee-training/

Java and JEE Training

About the Course

Java and JEE Certification Training is designed by professionals as per the industrial requirements and demands. This training encompasses comprehensive knowledge on basic and advanced concepts of core Java & J2EE along with popular frameworks like Hibernate, Spring & SOA. In this course, you will gain expertise in concepts like Java Array, Java OOPs, Java Function, Java Loops, Java Collections, Java Thread, Java Servlet, and Web Services using industry use-cases and this will help you to become a certified Java expert.

Why Should you take Java and JEE Training?

  • Java developers are in great demand in the job market. With average pay going between $90,000/- to $120,000/- depending on your experience and the employers.
  • Used by more than 10 Million developers worldwide to develop applications for 15 Billion devices.
  • Java is one of the most popular programming languages in the software world. Rated #1 in TIOBE Popular programming languages index (15th Consecutive Year)

What you will Learn in this Course?

Introduction to Java

  • Java Fundamentals
  • Introduction to Java Basics
  • Features of Java
  • Various components of Java language
  • Benefits of Java over other programming languages
  • Key Benefits of Java

Installation and IDE’s for Java Programming Language

  • Installation of Java
  • Setting up of Eclipse IDE
  • Components of Java Program
  • Editors and IDEs used for Java Programming
  • Writing a Simple Java Program

Data Handling and Functions

  • Data types, Operations, Compilation process, Class files, Loops, Conditions
  • Using Loop Constructs
  • Arrays- Single Dimensional and Multi-Dimensional
  • Functions
  • Functions with Arguments

OOPS in Java: Concept of Object Orientation

  • Object Oriented Programming in Java
  • Implement classes and objects in Java
  • Create Class Constructors
  • Overload Constructors
  • Inheritance
  • Inherit Classes and create sub-classes
  • Implement abstract classes and methods
  • Use static keyword
  • Implement Interfaces and use it

Polymorphism, Packages and String Handling

  • Concept of Static and Run time Polymorphism
  • Function Overloading
  • String Handling –String Class
  • Java Packages

Exception Handling and Multi-Threading

  • Exception handling
  • Various Types of Exception Handling
  • Introduction to multi-threading in Java
  • Extending the thread class
  • Synchronizing the thread

File Handling in Java

  • Input Output Streams
  • io Package
  • File Handling in Java

Java Collections

  • Wrapper Classes and Inner Classes: Integer, Character, Boolean, Float etc
  • Applet Programs: How to write UI programs with Applet, Java.lang, Java.io, Java.util
  • Collections: ArrayList, Vector, HashSet, TreeSet, HashMap, HashTable

Java Database Connectivity (JDBC)

  • Introduction to SQL: Connect, Insert, Update, Delete, Select
  • Introduction to JDBC and Architecture of JDBC
  • Insert/Update/Delete/Select Operations using JDBC
  • Batch Processing Transaction
  • Management: Commit and Rollback

Java Enterprise Edition – Servlets

  • Introduction to J2EE
  • Client Server architecture
  • URL, Port Number, Request, Response
  • Need for servlets
  • Servlet fundamentals
  • Setting up a web project in Eclipse
  • Configuring and running the web app with servlets
  • GET and POST request in web application with demo
  • Servlet lifecycle
  • Servlets Continued
  • Session tracking and filter
  • Forward and include Servlet request dispatchers

Java Server Pages (JSP)

  • Fundamentals of Java Server Page
  • Writing a code using JSP
  • The architecture of JSP
  • JSP Continued
  • JSP elements: Scriptlets, expressions, declaration
  • JSP standard actions
  • JSP directives
  • Introduction to JavaBeans
  • ServletConfig and ServletContext
  • Servlet Chaining
  • Cookies Management
  • Session Management

Hibernate

  • Introduction to Hibernate
  • Introduction to ORM
  • ORM features
  • Hibernate as an ORM framework
  • Hibernate features
  • Setting up a project with Hibernate framework
  • Basic APIs needed to do CRUD operations with Hibernate
  • Hibernate Architecture

POJO (Plain Old Java Object)

  • POJO (Plain Old Java Object)
  • Persistent Objects
  • Lifecycle of Persistent Object

Spring

  • Introduction to Spring
  • Spring Fundamentals
  • Advanced Spring

Got a question for us? Please mention it in the comments section and we will get back to you.

 

 

0 responses on "File Uploading in Servlets"

Leave a Message

Your email address will not be published. Required fields are marked *