Struts 2 download files sample application
In this example we will create Struts 2 download files sample application where client can download files from server.
- Maven project structure:
- pom.xml:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.javahonk</groupId> <artifactId>Struts2ExampleCode</artifactId> <packaging>war</packaging> <version>0.0.1-SNAPSHOT</version> <name>Struts2ExampleCode Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>org.apache.struts</groupId> <artifactId>struts2-core</artifactId> <version>2.3.16.3</version> </dependency> <dependency> <groupId>org.apache.struts</groupId> <artifactId>struts2-convention-plugin</artifactId> <version>2.3.16.3</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-io</artifactId> <version>1.3.2</version> </dependency> </dependencies> <build> <finalName>Struts2ExampleCode</finalName> </build> </project>
- web.xml:
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<filter>
<filter-name>struts2</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
<init-param>
<param-name>struts.devMode</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>struts.custom.i18n.resources</param-name>
<param-value>ApplicationResources</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>struts2</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
- index.jsp:
<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%> <%@ taglib prefix="s" uri="/struts-tags"%> <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>Struts 2 download files sample application</title> <s:head /> </head> <body> <h2 style="color: green"> <s:text name="label.welcome" /> </h2> Sample file download - <s:a href="downloadFileAction" theme="simple">CustomJar.jar</s:a> </body> </html>
- Struts2SampleCodeAction.java:
package com.javahonk.action;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.IOUtils;
import org.apache.struts2.ServletActionContext;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;
import com.opensymphony.xwork2.ActionSupport;
@Results({ @Result(name = "error", location = "/index.jsp"),
@Result(name = "input", location = "/index.jsp") })
public class Struts2SampleCodeAction extends ActionSupport {
private static final long serialVersionUID = 1L;
@Override
@Action(value = "/struts2SampleCodeAction")
public String execute() throws Exception {
return SUCCESS;
}
@Action(value = "/downloadFileAction")
public void downloadFileAction() throws Exception {
HttpServletResponse response = ServletActionContext.getResponse();
ServletContext context = ServletActionContext.getServletContext();
File downloadFile = new File("C:/JavaHonk/CustomJar.jar");
FileInputStream inputStream = null;
OutputStream outStream = null;
try {
inputStream = new FileInputStream(downloadFile);
response.setContentLength((int) downloadFile.length());
response.setContentType(context.getMimeType("C:/JavaHonk/CustomJar.jar"));
// response header details
String headerKey = "Content-Disposition";
String headerValue = String.format("attachment; filename=\"%s\"", downloadFile.getName());
response.setHeader(headerKey, headerValue);
// response
outStream = response.getOutputStream();
IOUtils.copy(inputStream, outStream);
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
if (null != inputStream)
inputStream.close();
if (null != inputStream)
outStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
- For this demo we will run this application on tomcat server use this tutorial to configure tomcat with eclipse. To run –> Right click project –> Run As –> Run on Server. You will see below page with download link:
- Once you click link download link file it show up below file download popup window :
For more information please read struts 2 tutorial here:
Download Project: Struts2ExampleCode
