File upload example in RESTEasy

Not many complete file upload example in JAX-RS, especially RESTEasy. Here, we show you two complete RESTEasy examples to handle file upload from HTML form.

Normal way to handle uploaded file via MultipartFormDataInput
Map uploaded file to a POJO class via @MultipartForm

1. RESTEasy Multipart Dependency

In RESTEasy, you need “resteasy-multipart-provider.jar” to handle multipart file upload.

File : pom.xml

	<dependency>
		<groupId>org.jboss.resteasy</groupId>
		<artifactId>resteasy-jaxrs</artifactId>
		<version>2.2.1.GA</version>
	</dependency>
 
	<dependency>
		<groupId>org.jboss.resteasy</groupId>
		<artifactId>resteasy-multipart-provider</artifactId>
		<version>2.2.0.GA</version>
	</dependency>
 
	<!-- optional, good for handle I/O task -->
	<dependency>
		<groupId>commons-io</groupId>
		<artifactId>commons-io</artifactId>
		<version>2.0.1</version>
	</dependency>

2. File Upload HTML Form

Simple HTML form to upload file.

<html>
<body>
	<h1>JAX-RS Upload Form</h1>
 
	<form action="rest/file/upload" method="post" enctype="multipart/form-data">
 
	   <p>
		Select a file : <input type="file" name="uploadedFile" size="50" />
	   </p>
 
	   <input type="submit" value="Upload It" />
	</form>
 
</body>
</html>

3.1 MultipartFormDataInput example

First example, the uploaded file will map to “MultipartFormDataInput” automatically.

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import org.apache.commons.io.IOUtils;
import org.jboss.resteasy.plugins.providers.multipart.InputPart;
import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput;
 
@Path("/file")
public class UploadFileService {
 
	private final String UPLOADED_FILE_PATH = "d:\\";
 
	@POST
	@Path("/upload")
	@Consumes("multipart/form-data")
	public Response uploadFile(MultipartFormDataInput input) {
 
		String fileName = "";
 
		Map<String, List<InputPart>> uploadForm = input.getFormDataMap();
		List<InputPart> inputParts = uploadForm.get("uploadedFile");
 
		for (InputPart inputPart : inputParts) {
 
		 try {
 
			MultivaluedMap<String, String> header = inputPart.getHeaders();
			fileName = getFileName(header);
 
			//convert the uploaded file to inputstream
			InputStream inputStream = inputPart.getBody(InputStream.class,null);
 
			byte [] bytes = IOUtils.toByteArray(inputStream);
 
			//constructs upload file path
			fileName = UPLOADED_FILE_PATH + fileName;
 
			writeFile(bytes,fileName);
 
			System.out.println("Done");
 
		  } catch (IOException e) {
			e.printStackTrace();
		  }
 
		}
 
		return Response.status(200)
		    .entity("uploadFile is called, Uploaded file name : " + fileName).build();
 
	}
 
	/**
	 * header sample
	 * {
	 * 	Content-Type=[image/png], 
	 * 	Content-Disposition=[form-data; name="file"; filename="filename.extension"]
	 * }
	 **/
	//get uploaded filename, is there a easy way in RESTEasy?
	private String getFileName(MultivaluedMap<String, String> header) {
 
		String[] contentDisposition = header.getFirst("Content-Disposition").split(";");
 
		for (String filename : contentDisposition) {
			if ((filename.trim().startsWith("filename"))) {
 
				String[] name = filename.split("=");
 
				String finalFileName = name[1].trim().replaceAll("\"", "");
				return finalFileName;
			}
		}
		return "unknown";
	}
 
	//save to somewhere
	private void writeFile(byte[] content, String filename) throws IOException {
 
		File file = new File(filename);
 
		if (!file.exists()) {
			file.createNewFile();
		}
 
		FileOutputStream fop = new FileOutputStream(file);
 
		fop.write(content);
		fop.flush();
		fop.close();
 
	}
}

In this example, if you select a file “c:\\abc.png” from your local C drive, click on the submit button, then it will uploaded to “d:\\abc.png“.

Download it – JAX-RS-FileUpload-Resteasy-Example1.zip (8 KB)

3.2 MultipartForm example

This example will map the uploaded file to a POJO class, you dun need to handle the inputPart like 3.1 example.

POJO file, map uploaded file to this class.

import javax.ws.rs.FormParam;
import org.jboss.resteasy.annotations.providers.multipart.PartType;
 
public class FileUploadForm {
 
	public FileUploadForm() {
	}
 
	private byte[] data;
 
	public byte[] getData() {
		return data;
	}
 
	@FormParam("uploadedFile")
	@PartType("application/octet-stream")
	public void setData(byte[] data) {
		this.data = data;
	}
 
}

Handle the uploaded file.

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
import org.jboss.resteasy.annotations.providers.multipart.MultipartForm;
 
@Path("/file")
public class UploadFileService {
 
	@POST
	@Path("/upload")
	@Consumes("multipart/form-data")
	public Response uploadFile(@MultipartForm FileUploadForm form) {
 
		String fileName = "d:\\anything";
 
		try {
			writeFile(form.getData(), fileName);
		} catch (IOException e) {
 
			e.printStackTrace();
		}
 
		System.out.println("Done");
 
		return Response.status(200)
		    .entity("uploadFile is called, Uploaded file name : " + fileName).build();
 
	}
 
	// save to somewhere
	private void writeFile(byte[] content, String filename) throws IOException {
 
		File file = new File(filename);
 
		if (!file.exists()) {
			file.createNewFile();
		}
 
		FileOutputStream fop = new FileOutputStream(file);
 
		fop.write(content);
		fop.flush();
		fop.close();
 
	}
}

The problem is, you can’t get the uploaded filename! To fix it, you can put a textbox in HTML form, so that user is able to key in the uploaded filename, and map it to “FileUploadForm” via @FormParam("filename").

Download it – JAX-RS-FileUpload-Resteasy-Example2.zip (8 KB)

Conclusion

Overall, RESTEasy is able to handle multipart well, but it’s rather hard to get the uploaded file header information, like filename. Or, may be i do not know how to use the RESTEasy API?

Note
Please comment or correct me if you have a more elegant way to get the uploaded filename.

References

Note : You can find more similar articles at - JAX-RS Tutorials

10 Comments

April 9, 2012 at 6:23 pm

noman ali :

Hi,
Nice article but i m facing a problem, as you mentioned create a textbox in html form and get it via @FormParam but unfortunately i m unable to get it.

private byte[] data;
	private String fileName;
 
	@FormParam("securityToken")	
	public String getFileName() {
		return fileName;
	}
 
	public void setFileName(String fileName) {
		this.fileName = fileName;
	}
 
	public byte[] getData() {
		return data;
	}
 
	@FormParam("uploadFile")
	@PartType("application/octet-stream")
	public void setData(byte[] data) {
		this.data = data;
	}

Select a file : <input type="file" name="uploadFile" size="50" onchange="javascript: getFilename(this.value);" />
 
 
	Security token: <input type="text" name="securityToken" size="50" /><br>
	<input type="submit" value="Upload File" />

February 25, 2012 at 7:59 am

barney :

Hi Mkyong,

How do you run this project? I downloaded your zip file and unzipped it, but noticed you’re not using jetty. Thanks, great site.

Barney

February 25, 2012 at 8:37 am
barney :
OK got it, just drop it into a tomcat/webapp dir.
Reply

October 6, 2011 at 1:35 pm

muhammed :

hi i use it but when i post from html
it gives me The request sent by the client was syntactically incorrect (java.lang.RuntimeException: Could find no Content-Disposition header within part).
error please help

August 13, 2011 at 5:52 pm

zhaixuepan :

get filename

MultivaluedMap heades = part.getHeaders();
            String CDHeader = heades.getFirst("Content-Disposition");
            String fileName ="";
            Pattern p =  Pattern.compile("filename=\".*\""); 
            Matcher m = p.matcher(CDHeader);            
            if (m.find()){
                fileName = m.group();
            }

July 18, 2011 at 1:50 pm

File upload example in Jersey :

[...] Download it – JAX-RS-FileUpload-Jersey-Example.zip (6 KB)ReferencesJersey Official WebsiteFile Upload example in RESTEasy [...]

July 12, 2011 at 11:51 pm

Diego :

Hi mkyong, how did you test this? And how could you do that using resteasy-client part?

Thanks for this articule, it was very helpfull

Diego

July 18, 2011 at 1:54 pm
mkyong :
To test it, just use a simple html form in step 2. Of course you can test it with resteasy client or other http library like Apache httpclient.
Reply
- July 20, 2011 at 10:46 pm
  Diego :
  I have this working ok, and i can test it using a simple html form but i can’t make it work with resteasy client framework
  I sent a mail a week ago to the resteasy’s list but not answer
  http://sourceforge.net/mailarchive/forum.php?thread_name=CAHr_oMsZkhCyo%3DWP3UP7T3sFdsO-oHORcrMrxL2xQ5yw7zbxxg%40mail.gmail.com&forum_name=resteasy-users
  Can you post the client part using the resteasy client framework (not with html form)?
  Thanks!
  Reply
  - July 21, 2011 at 9:47 am
    mkyong :
    see this – http://www.mkyong.com/webservices/jax-rs/restful-java-client-with-resteasy-client-framework/
    Reply

File upload example in RESTEasy

1. RESTEasy Multipart Dependency

2. File Upload HTML Form

3.1 MultipartFormDataInput example

3.2 MultipartForm example

Conclusion

References

Subscribe to the Mkyong.com Newsletter

Related Posts

Popular Posts

10 Comments

Leave a Reply

Recent Posts

All Available Tutorials

Favorites Links

Friends & Links

About Mkyong.com