Sunday, April 24, 2011

Jersey posting multipart data

This took me sometime to figure out mostly it was because I was only including jersey-multipart-1.6.jar but I was not including mimepull-1.3.jar.

So the intent is to upload a file using REST api and we need pass meta attributes in addition to uploading the file. Also the intent is to stream the file instead of first storing it on the local disk. Here is some sample code.

@Path("/upload-service")
public class UploadService {
 @Context
 protected HttpServletResponse response;
 @Context
 protected HttpServletRequest request;

 @POST
 @Consumes(MediaType.MULTIPART_FORM_DATA)
 @Produces(MediaType.APPLICATION_JSON)
 public String uploadFile(@PathParam("fileName") final String fileName,
   @FormDataParam("workgroupId") String workgroupId,
   @FormDataParam("userId") final int userId,
   @FormDataParam("content") final InputStream content) throws JSONException {
  //.......Upload the file to S3 or netapp or any storage service
 }
}


Now to test this service I used Jersey client api and it was easy to test this.


public class UploadServiceTest  extends JerseyTest {
 public UploadServiceTest() {
   super(new WebAppDescriptor.Builder(UploadService.class
    .getPackage().getName()).contextPath("/public/rest").build());
 }
 
 @Override
    protected TestContainerFactory getTestContainerFactory() {
        return new GrizzlyWebTestContainerFactory();
    }
 @Test
 public void testUploadService() throws Exception {
  WebResource webResource = resource();

  FormDataMultiPart form = new FormDataMultiPart();
  form.field("fileName", "/Shared/marketing/scrap.txt");
  form.field("workgroupId", "XXX");
  form.field("userId", 1001);
  String content = "This is a binary content";

  FormDataBodyPart fdp = new FormDataBodyPart("content",
    new ByteArrayInputStream(content.getBytes()),
    MediaType.APPLICATION_OCTET_STREAM_TYPE);
  form.bodyPart(fdp);

  String responseJson = webResource.path(
    "upload-service").type(MediaType.MULTIPART_FORM_DATA)
    .post(String.class, form);
 }
}


6 comments:

  1. Thanks, this helped

    ReplyDelete
  2. Hello there!

    I tried your code above and I got the error:
    SEVERE: The following errors and warnings have been detected with resource and/or provider classes:
    SEVERE: Missing dependency for method public javax.ws.rs.core.Response com.test.rest.api.TestPostService.testPost(java.lang.String,java.io.InputStream) at parameter at index 1
    SEVERE: Method, public javax.ws.rs.core.Response com.test.rest.api.TestPostService.testPost(java.lang.String,java.io.InputStream), annotated with POST of resource, com.test.rest.api.TestPostService, is not recognized as valid resource method.

    Here's my method:
    ------------------
    @POST
    @Consumes(MediaType.MULTIPART_FORM_DATA)
    @Produces(MediaType.APPLICATION_XML)
    @Path("/testpost")
    public Response testPost( @QueryParam("mac") String mac,
    @FormDataParam("content") InputStream content) {
    }



    And here's my client program:


    FormDataMultiPart fdmp = new FormDataMultiPart();

    String imgFile = "C:\\temp\test.jpg";
    MultivaluedMap params = new MultivaluedMapImpl();
    params.add("mac", "11-22-33-44-55-66");


    FormDataMultiPart fdmp = new FormDataMultiPart();
    File f = new File(imgFile);
    fdmp.bodyPart(new FileDataBodyPart("content", f, MediaType.APPLICATION_OCTET_STREAM_TYPE));

    ClientResponse response = service.path("apis")
    .path("/getcapturedurl")
    .queryParams(params)
    .type(MediaType.MULTIPART_FORM_DATA).post(ClientResponse.class,fdmp);
    System.out.println( response );





    I also tried this one, with no luck :(

    FormDataMultiPart form = new FormDataMultiPart();
    form.field("content", imgFile);

    FormDataBodyPart fdp = new FormDataBodyPart("content",
    new ByteArrayInputStream(imgFile.getBytes()),
    MediaType.APPLICATION_OCTET_STREAM_TYPE);
    form.bodyPart(fdp);


    ClientResponse response = service.path("apis")
    .path("/getcapturedurl")
    .queryParams(params)
    .type(MediaType.MULTIPART_FORM_DATA).post(ClientResponse.class,form);
    System.out.println( response );


    Any idea?

    Thanks

    ReplyDelete
  3. make sure all depending jersey jars are of same version..

    ReplyDelete
  4. How to use jersey client api in an android context?

    ReplyDelete
    Replies
    1. I have less idea about it but do you really want that overhead of using jersey client api? you might want to check out this http://developer.android.com/reference/org/apache/http/client/HttpClient.html

      Delete