In JAX-RS, for user to download an image file, annotate the method with @Produces("image/image-type") :

  1. Put @Produces(“image/png”) on service method, for “png” image.
  2. Set “Content-Disposition” in Response header to prompt a download box.
Note
For other image types, refer to this list of the image types

1. Download Image in JAX-RS

Full example to download an image file from JAX-RS.

import java.io.File;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.ResponseBuilder;
 
@Path("/image")
public class ImageService {
 
	private static final String FILE_PATH = "c:\\mkyong-logo.png";
 
	@GET
	@Path("/get")
	@Produces("image/png")
	public Response getFile() {
 
		File file = new File(FILE_PATH);
 
		ResponseBuilder response = Response.ok((Object) file);
		response.header("Content-Disposition",
			"attachment; filename=image_from_server.png");
		return response.build();
 
	}
 
}

2. Demo

Access this URI pattern : “/image/get“.

Figure : Image file “c:\\mkyong-logo.png” from server is prompted for user to download, with a new file name “image_from_server.png“

download image from server

Download Source Code

Download it – JAX-RS-Download-ImageFile-Example.zip (6 KB)

References

  1. JAX-RS @Produces JavaDoc
  2. list of the images types
Note : You can find more similar articles at - JAX-RS Tutorials
You might also like this tutorials :
Apache Wicket Tutorials
Java I/O Tutorials
Google App Engine Tutorials
Java RegEx Tutorials
Java MongoDB Tutorials