Java File Upload REST service

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3. <modelVersion>4.0.0</modelVersion>
5. <groupId>net.javatutorial.tutorials</groupId>
6. <artifactId>FileUploaderRESTService</artifactId>
7. <version>1</version>
8. <packaging>war</packaging>
10. <name>File Uploader Rest Service</name>
11. <url>https://javatutorial.net</url>
13. <properties>
14. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
15. </properties>
17. <dependencies>
18. <dependency>
19. <groupId>com.sun.jersey</groupId>
20. <artifactId>jersey-server</artifactId>
21. <version>1.8</version>
22. </dependency>
23. <dependency>
24. <groupId>com.sun.jersey</groupId>
25. <artifactId>jersey-servlet</artifactId>
26. <version>1.17.1</version>
27. </dependency>
28. <dependency>
29. <groupId>com.sun.jersey</groupId>
30. <artifactId>jersey-json</artifactId>
31. <version>1.8</version>
32. </dependency>
33. <dependency>
34. <groupId>com.sun.jersey.contribs</groupId>
35. <artifactId>jersey-multipart</artifactId>
36. <version>1.8</version>
37. </dependency>
38. </dependencies>
40. <build>
41. <plugins>
42. <plugin>
43. <groupId>org.apache.maven.plugins</groupId>
44. <artifactId>maven-compiler-plugin</artifactId>
45. <version>3.1</version>
46. <inherited>true</inherited>
47. <configuration>
48. <source>1.7</source>
49. <target>1.7</target>
50. </configuration>
51. </plugin>
52. <plugin>
53. <artifactId>maven-war-plugin</artifactId>
54. <version>2.3</version>
55. <configuration>
56. <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
57. <webResources>
58. <resource>
59. <!-- this is relative to the pom.xml directory -->
60. <directory>${project.basedir}/src/main/resources
61. </directory>
62. </resource>
63. </webResources>
64. </configuration>
65. </plugin>
66. </plugins>
67. </build>
69. </project>

<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/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>net.javatutorial.tutorials</groupId>
	<artifactId>FileUploaderRESTService</artifactId>
	<version>1</version>
	<packaging>war</packaging>

	<name>File Uploader Rest Service</name>
	<url>https://javatutorial.net</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-server</artifactId>
			<version>1.8</version>
		</dependency>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-servlet</artifactId>
			<version>1.17.1</version>
		</dependency>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-json</artifactId>
			<version>1.8</version>
		</dependency>
		<dependency>
			<groupId>com.sun.jersey.contribs</groupId>
			<artifactId>jersey-multipart</artifactId>
			<version>1.8</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.1</version>
				<inherited>true</inherited>
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-war-plugin</artifactId>
				<version>2.3</version>
				<configuration>
					<webXml>src/main/webapp/WEB-INF/web.xml</webXml>
					<webResources>
						<resource>
							<!-- this is relative to the pom.xml directory -->
							<directory>${project.basedir}/src/main/resources
							</directory>
						</resource>
					</webResources>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>

1. package net.javatutorial.tutorials.services;
3. import java.io.File;
4. import java.io.FileOutputStream;
5. import java.io.IOException;
6. import java.io.InputStream;
7. import java.io.OutputStream;
9. import javax.ws.rs.Consumes;
10. import javax.ws.rs.POST;
11. import javax.ws.rs.Path;
12. import javax.ws.rs.core.Context;
13. import javax.ws.rs.core.MediaType;
14. import javax.ws.rs.core.Response;
15. import javax.ws.rs.core.UriInfo;
17. import com.sun.jersey.core.header.FormDataContentDisposition;
18. import com.sun.jersey.multipart.FormDataParam;
20. /**
21. * This example shows how to build Java REST web-service to upload files
22. * accepting POST requests with encoding type "multipart/form-data". For more
23. * details please read the full tutorial on
24. * https://javatutorial.net/java-file-upload-rest-service
25. *
26. * @author javatutorial.net
27. */
28. @Path("/upload")
29. public class FileUploadService {
31. /** The path to the folder where we want to store the uploaded files */
32. private static final String UPLOAD_FOLDER = "c:/uploadedFiles/";
34. public FileUploadService() {
35. }
37. @Context
38. private UriInfo context;
40. /**
41. * Returns text response to caller containing uploaded file location
42. *
43. * @return error response in case of missing parameters an internal
44. * exception or success response if file has been stored
45. * successfully
46. */
47. @POST
48. @Consumes(MediaType.MULTIPART_FORM_DATA)
49. public Response uploadFile(
50. @FormDataParam("file") InputStream uploadedInputStream,
51. @FormDataParam("file") FormDataContentDisposition fileDetail) {
53. // check if all form parameters are provided
54. if (uploadedInputStream == null || fileDetail == null)
55. return Response.status(400).entity("Invalid form data").build();
57. // create our destination folder, if it not exists
58. try {
59. createFolderIfNotExists(UPLOAD_FOLDER);
60. } catch (SecurityException se) {
61. return Response.status(500)
62. .entity("Can not create destination folder on server")
63. .build();
64. }
66. String uploadedFileLocation = UPLOAD_FOLDER + fileDetail.getFileName();
67. try {
68. saveToFile(uploadedInputStream, uploadedFileLocation);
69. } catch (IOException e) {
70. return Response.status(500).entity("Can not save file").build();
71. }
73. return Response.status(200)
74. .entity("File saved to " + uploadedFileLocation).build();
75. }
77. /**
78. * Utility method to save InputStream data to target location/file
79. *
80. * @param inStream
81. * - InputStream to be saved
82. * @param target
83. * - full path to destination file
84. */
85. private void saveToFile(InputStream inStream, String target)
86. throws IOException {
87. OutputStream out = null;
88. int read = 0;
89. byte[] bytes = new byte[1024];
91. out = new FileOutputStream(new File(target));
92. while ((read = inStream.read(bytes)) != -1) {
93. out.write(bytes, 0, read);
94. }
95. out.flush();
96. out.close();
97. }
99. /**
100. * Creates a folder to desired location if it not already exists
101. *
102. * @param dirName
103. * - full path to the folder
104. * @throws SecurityException
105. * - in case you don't have permission to create the folder
106. */
107. private void createFolderIfNotExists(String dirName)
108. throws SecurityException {
109. File theDir = new File(dirName);
110. if (!theDir.exists()) {
111. theDir.mkdir();
112. }
113. }
115. }

package net.javatutorial.tutorials.services;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

import com.sun.jersey.core.header.FormDataContentDisposition;
import com.sun.jersey.multipart.FormDataParam;

/**
 * This example shows how to build Java REST web-service to upload files
 * accepting POST requests with encoding type "multipart/form-data". For more
 * details please read the full tutorial on
 * https://javatutorial.net/java-file-upload-rest-service
 * 
 * @author javatutorial.net
 */
@Path("/upload")
public class FileUploadService {

	/** The path to the folder where we want to store the uploaded files */
	private static final String UPLOAD_FOLDER = "c:/uploadedFiles/";

	public FileUploadService() {
	}

	@Context
	private UriInfo context;

	/**
	 * Returns text response to caller containing uploaded file location
	 * 
	 * @return error response in case of missing parameters an internal
	 *         exception or success response if file has been stored
	 *         successfully
	 */
	@POST
	@Consumes(MediaType.MULTIPART_FORM_DATA)
	public Response uploadFile(
			@FormDataParam("file") InputStream uploadedInputStream,
			@FormDataParam("file") FormDataContentDisposition fileDetail) {

		// check if all form parameters are provided
		if (uploadedInputStream == null || fileDetail == null)
			return Response.status(400).entity("Invalid form data").build();

		// create our destination folder, if it not exists
		try {
			createFolderIfNotExists(UPLOAD_FOLDER);
		} catch (SecurityException se) {
			return Response.status(500)
					.entity("Can not create destination folder on server")
					.build();
		}

		String uploadedFileLocation = UPLOAD_FOLDER + fileDetail.getFileName();
		try {
			saveToFile(uploadedInputStream, uploadedFileLocation);
		} catch (IOException e) {
			return Response.status(500).entity("Can not save file").build();
		}

		return Response.status(200)
				.entity("File saved to " + uploadedFileLocation).build();
	}

	/**
	 * Utility method to save InputStream data to target location/file
	 * 
	 * @param inStream
	 *            - InputStream to be saved
	 * @param target
	 *            - full path to destination file
	 */
	private void saveToFile(InputStream inStream, String target)
			throws IOException {
		OutputStream out = null;
		int read = 0;
		byte[] bytes = new byte[1024];

		out = new FileOutputStream(new File(target));
		while ((read = inStream.read(bytes)) != -1) {
			out.write(bytes, 0, read);
		}
		out.flush();
		out.close();
	}

	/**
	 * Creates a folder to desired location if it not already exists
	 * 
	 * @param dirName
	 *            - full path to the folder
	 * @throws SecurityException
	 *             - in case you don't have permission to create the folder
	 */
	private void createFolderIfNotExists(String dirName)
			throws SecurityException {
		File theDir = new File(dirName);
		if (!theDir.exists()) {
			theDir.mkdir();
		}
	}

}

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3. xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
4. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
5. id="WebApp_ID" version="2.5">
6. <display-name>net.javatutorial.tutorials.services</display-name>
7. <servlet>
8. <servlet-name>Jersey REST Service</servlet-name>
9. <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
10. <init-param>
11. <param-name>com.sun.jersey.config.property.packages</param-name>
12. <param-value>net.javatutorial.tutorials.services</param-value>
13. </init-param>
14. <load-on-startup>1</load-on-startup>
15. </servlet>
16. <servlet-mapping>
17. <servlet-name>Jersey REST Service</servlet-name>
18. <url-pattern>/rest/*</url-pattern>
19. </servlet-mapping>
20. </web-app>

<?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" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	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>net.javatutorial.tutorials.services</display-name>
	<servlet>
		<servlet-name>Jersey REST Service</servlet-name>
		<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
		<init-param>
			<param-name>com.sun.jersey.config.property.packages</param-name>
			<param-value>net.javatutorial.tutorials.services</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>Jersey REST Service</servlet-name>
		<url-pattern>/rest/*</url-pattern>
	</servlet-mapping>
</web-app>

1. Choose file to upload<br>
2. <form action="http://localhost:8080/FileUploaderRESTService-1/rest/upload" method="post" enctype="multipart/form-data">
3. <input name="file" id="filename" type="file" /><br><br>
4. <button name="submit" type="submit">Upload</button>
5. </form>

Choose file to upload<br>
<form action="http://localhost:8080/FileUploaderRESTService-1/rest/upload" method="post" enctype="multipart/form-data">
	<input name="file" id="filename" type="file" /><br><br>
	<button name="submit" type="submit">Upload</button>
</form>

1. package net.javatutorial.tutorials.clienst;
3. import java.io.File;
4. import java.io.FileInputStream;
5. import java.io.IOException;
7. import org.apache.http.HttpEntity;
8. import org.apache.http.HttpResponse;
9. import org.apache.http.client.ClientProtocolException;
10. import org.apache.http.client.methods.HttpPost;
11. import org.apache.http.entity.mime.MultipartEntity;
12. import org.apache.http.entity.mime.content.InputStreamBody;
13. import org.apache.http.impl.client.DefaultHttpClient;
14. import org.apache.http.params.BasicHttpParams;
15. import org.apache.http.util.EntityUtils;
17. /**
18. * This example shows how to upload files using POST requests
19. * with encoding type "multipart/form-data".
20. * For more details please read the full tutorial
21. * on https://javatutorial.net/java-file-upload-rest-service
22. * @author javatutorial.net
23. */
24. public class FileUploaderClient {
26. public static void main(String[] args) {
28. // the file we want to upload
29. File inFile = new File("C:\\Users\\admin\\Desktop\\Yana-make-up.jpg");
30. FileInputStream fis = null;
31. try {
32. fis = new FileInputStream(inFile);
33. DefaultHttpClient httpclient = new DefaultHttpClient(new BasicHttpParams());
35. // server back-end URL
36. HttpPost httppost = new HttpPost("http://localhost:8080/FileUploaderRESTService-1/rest/upload");
37. MultipartEntity entity = new MultipartEntity();
39. // set the file input stream and file name as arguments
40. entity.addPart("file", new InputStreamBody(fis, inFile.getName()));
41. httppost.setEntity(entity);
43. // execute the request
44. HttpResponse response = httpclient.execute(httppost);
46. int statusCode = response.getStatusLine().getStatusCode();
47. HttpEntity responseEntity = response.getEntity();
48. String responseString = EntityUtils.toString(responseEntity, "UTF-8");
50. System.out.println("[" + statusCode + "] " + responseString);
52. } catch (ClientProtocolException e) {
53. System.err.println("Unable to make connection");
54. e.printStackTrace();
55. } catch (IOException e) {
56. System.err.println("Unable to read file");
57. e.printStackTrace();
58. } finally {
59. try {
60. if (fis != null) fis.close();
61. } catch (IOException e) {}
62. }
63. }
65. }

package net.javatutorial.tutorials.clienst;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.InputStreamBody;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.util.EntityUtils;

/**
 * This example shows how to upload files using POST requests 
 * with encoding type "multipart/form-data".
 * For more details please read the full tutorial
 * on https://javatutorial.net/java-file-upload-rest-service
 * @author javatutorial.net
 */
public class FileUploaderClient {
	
	public static void main(String[] args) {
		
		// the file we want to upload
		File inFile = new File("C:\\Users\\admin\\Desktop\\Yana-make-up.jpg");
		FileInputStream fis = null;
		try {
			fis = new FileInputStream(inFile);
			DefaultHttpClient httpclient = new DefaultHttpClient(new BasicHttpParams());
			
			// server back-end URL
			HttpPost httppost = new HttpPost("http://localhost:8080/FileUploaderRESTService-1/rest/upload");
			MultipartEntity entity = new MultipartEntity();

			// set the file input stream and file name as arguments
			entity.addPart("file", new InputStreamBody(fis, inFile.getName()));
			httppost.setEntity(entity);

			// execute the request
			HttpResponse response = httpclient.execute(httppost);
			
			int statusCode = response.getStatusLine().getStatusCode();
			HttpEntity responseEntity = response.getEntity();
			String responseString = EntityUtils.toString(responseEntity, "UTF-8");
			
			System.out.println("[" + statusCode + "] " + responseString);
			
		} catch (ClientProtocolException e) {
			System.err.println("Unable to make connection");
			e.printStackTrace();
		} catch (IOException e) {
			System.err.println("Unable to read file");
			e.printStackTrace();
		} finally {
			try {
				if (fis != null) fis.close();
			} catch (IOException e) {}
		}
	}
	
}