Spring 3 MVC file upload Example

Our Goal

Our goal is to create a File Upload Application in Spring 3 MVC and Hibernate. Following is the functionality.

1. A form is displayed on main page with fields such as browse button to select document from file system.
2. User can select any document from local drive and upload the same using Save document functionality.
3. All the documents saved are added in a database table.

Here is the final screen shot of File Upload Application.

Step 1: Create Database Table

For File Upload application, we will use Oracle database. Create a table documents in a table fileupload. Feel free to extend this example and create a more complex application.

CREATE TABLE "FILEUPLOAD_18796"

  "FILEID" NUMBER(10,0) NOT NULL ENABLE, "MYFILE" BLOB NOT NULL ENABLE

);




Step 2: Add the required jar files under lib folder.

Entity class – The Hibernate model class

Let us start with the coding of File Upload application. First we will create a model object or hibernate POJO class to store document information. Also this class will be an Entity class and will be linked with DOCUMENTS table in database.

public class FileUpload {
long fileid;
private Blob myfile;
private MultipartFile file;
private String message;
public FileUpload() //Default constructor for spring bean configuration.
{

}
// Add getters and setters.

}

The Hibernate Util Class

public class HibernateUtil {
    SessionFactory sessionfactory;
    public HibernateUtil()
    {
         //CreatingSessionfactory
    sessionfactory=new Configuration().configure().buildSessionFactory();
    }
    public SessionFactory getSessionFactory()
    {
return sessionfactory;
   
    }
}

The Data Access (DAO) Layer

package in.fileupload;

import java.util.ArrayList;

import in.fileupload.HibernateUtil;

import org.hibernate.HibernateException;

import org.hibernate.Session;

import org.hibernate.SessionFactory;

import org.hibernate.Transaction;

public class FileUploadDao {

private FileUpload fu;

public FileUpload getFu() {

return fu;

}

public void setFu(FileUpload fu) {

this.fu = fu;

}

public void saveBlobFile(FileUpload fileupload)

{

Session session=null;

HibernateUtil util=new HibernateUtil();

Transaction transaction=null;

try{

SessionFactory sessionfactory=util.getSessionFactory();

session=sessionfactory.openSession();

transaction=session.beginTransaction();

session.save(fileupload);

transaction.commit();

System.out.println("File Uploaded Successfully");

}catch(HibernateException ex)

{

transaction.rollback();

System.out.println("******Hibernate Exep " +ex.getMessage());

ex.printStackTrace();

}catch(Exception ex)

{

transaction.rollback();

System.out.println("******Exception " +ex.getMessage());

ex.printStackTrace();

}finally

{

try

{

session.flush();

session.close();

System.out.println("session closed");

}catch (HibernateException ex) {

// TODO: handle exception

System.out.println("******HibernateException " +ex.getMessage());

ex.printStackTrace();

}

}

}

}

The Controller Class

public class FileUploadController extends MultiActionController {

private FileUploadDao fileupdao;
public FileUploadDao getFileupdao() {
return fileupdao;
}
public void setFileupdao(FileUploadDao fileupdao) {
this.fileupdao = fileupdao;
}
public ModelAndView saveBlob(HttpServletRequest request, HttpServletResponse response, @ModelAttribute("fileUploadForm") FileUpload fileUploadForm) throws Exception
{

MultipartFile file = fileUploadForm.getFile();
System.out.println("Save Method Called");
try{
Blob blob = Hibernate.createBlob(file.getInputStream());
fileUploadForm.setMyfile(blob);
fileupdao.saveBlobFile(fileUploadForm);


System.out.println("<<<<< File Data Updated Successfully >>>>>");
fileUploadForm.setMessage(file.getOriginalFilename());

}catch(Exception e)
{
e.printStackTrace();
}
return new ModelAndView("success","fileUploadForm",fileUploadForm);
}

public ModelAndView redirect(HttpServletRequest request,
HttpServletResponse response) throws Exception {
return new ModelAndView("upload", "", "");
}

Adding Spring MVC Support to Webapplication

Let us add Spring MVC support to our web application.
Update the web.xml file and add servlet mapping for org.springframework.web.servlet.DispatcherServlet. Also note that we have mapped url / with dispatcherServlet so all the request are handled by spring.

File: /src/webapp/WEB-INF/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_2_5.xsd" id="WebApp_ID" version="2.5">

  <display-name>SpringFileUpload</display-name>

  <welcome-file-list>

    <welcome-file>upload.jsp</welcome-file>

  </welcome-file-list>

  <servlet>

        <servlet-name>dispatcher</servlet-name>

        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

        <load-on-startup>1</load-on-startup>

    </servlet>

    <servlet-mapping>

        <servlet-name>dispatcher</servlet-name>

        <url-pattern>*.htm</url-pattern>

    </servlet-mapping>

  <context-param>

        <param-name>contextConfigLocation</param-name>

        <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>

    </context-param>

  <listener>

    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

</listener>
</web-app>

File: /src/main/webapp/WEB-INF/dispatcher-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

<bean class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping" />
  
<bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/jsp/" p:suffix=".jsp">
          </bean>
          
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
</bean>

<bean name="/fileupload/*.htm"  class="in.fileupload.FileUploadController">
<property name="fileupdao" ref="fileupdao"></property>
</bean>
<bean name="fu" class="in.fileupload.FileUpload"></bean>

<bean name="fileread" class="in.fileupload.FileRead">
<property name="fileupdao" ref="fileupdao"></property>
</bean>

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName"  value="oracle.jdbc.driver.OracleDriver"></property>
<property name="url" value="jdbc:oracle:thin:@oraapps-test.india.rapidigm.com:1532/FCPR12"></property>
<property name="username" value="oratrain1"></property>
<property name="password" value="oratrain1"></property>
</bean>

<bean id="mysessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
<property name="dataSource" ref="dataSource"></property>
</bean>

<bean id="d" class="in.fileupload.HibernateUtil">
</bean>
<bean id="fileupdao" class="in.fileupload.FileUploadDao">
<property name="fu" ref="fu"></property>
</bean>

</beans>

Adding Hibernete Support to Webapplication

src/hibernate.cfg.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD//EN"
             "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
 <session-factory name="">
  <property name="hibernate.connection.driver_class">oracle.jdbc.driver.OracleDriver</property>
  <property name="hibernate.connection.url">"Your Connection URL"</property>
  <property name="hibernate.connection.username">"Un for db"</property>
  <property name="hibernate.connection.password">"PW for db"</property>
  <property name="hibernate.connection.pool_size">10</property>
  <property name="show_sql">true</property>
  <property name="dialect">org.hibernate.dialect.OracleDialect</property>
  <property name="hibernate.hbm2ddl.auto">update</property>
  <mapping resource="Employee.hbm.xml"/>
 </session-factory>
</hibernate-configuration>

src/Employee.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
                                   "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<!-- Generated 29 May, 2013 2:01:36 PM by Hibernate Tools 3.4.0.CR1 -->
<hibernate-mapping>
 <class name="in.fileupload.FileUpload" table="fileupload">
  <id name="fileid" type="long">
   <column name="fileid"/>
   <generator class="increment"/>
  </id>
  <property name="myfile" type="blob">
   <column name="myfile"/>
  </property>
 </class>

</hibernate-mapping>

Finally add following index.jsp file to Web Content.

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
    <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>File Upload Example</title>
</head>
<body>
<div>
<form:form method="post" name="UploadForm" action="fileupload/saveBlob.htm" enctype="multipart/form-data" commandName="fileUploadForm" onsubmit="return checkUploadForm()">
<center>Please select a file to upload : <hr>
<input type="file" name="file" id="file"/>&nbsp;&nbsp;
<input type="submit" value="upload" id="select"/>
</center>
</form:form></div>

</body>

</html>

Success.jsp file to WEB-INF/jsp folder.

<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>Success Page</title> </head> <body> <center><h3>Your File <font color="blue">${fileUploadForm.message}</font> Has Been Uploaded Successfully</h3> <a href="redirect.htm"><font color="black">Home</font></a></center> </body>
</html>

That’s All folks