How do I write a restful web service that accepts a binary file (pdf)

Preston picture Preston · Jul 21, 2009 · Viewed 38.5k times · Source

I'm trying to write a restful web service in java that will take a few string params and a binary file (pdf) param.

I understand how to do the strings but I'm getting hung up on the binary file. Any ideas / examples?

Here's what I have so far

@GET
@ConsumeMime("multipart/form-data")
@ProduceMime("text/plain")
@Path("submit/{client_id}/{doc_id}/{html}/{password}")
public Response submit(@PathParam("client_id") String clientID,
                   @PathParam("doc_id") String docID,
                   @PathParam("html") String html,
                   @PathParam("password") String password,
                   @PathParam("pdf") File pdf) {
  return Response.ok("true").build();
}

Since I've posted this the link that had the answer has been removed, so here is my implementation.

@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.TEXT_PLAIN)
@Path("submit")
public Response submit(@FormDataParam("clientID") String clientID,
                   @FormDataParam("html") String html,
                   @FormDataParam("pdf") InputStream pdfStream) {

    try {
        byte[] pdfByteArray = DocUtils.convertInputStreamToByteArrary(pdfStream);
    } catch (Exception ex) {
        return Response.status(600).entity(ex.getMessage()).build();
    }
}


...

public static byte[] convertInputStreamToByteArrary(InputStream in) throws IOException {
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    final int BUF_SIZE = 1024;
    byte[] buffer = new byte[BUF_SIZE];
    int bytesRead = -1;
    while ((bytesRead = in.read(buffer)) > -1) {
        out.write(buffer, 0, bytesRead);
    }
    in.close();
    byte[] byteArray = out.toByteArray();
    return byteArray;
}

Answer

Preston picture Preston · Mar 17, 2015
@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.TEXT_PLAIN)
@Path("submit")
public Response submit(@FormDataParam("clientID") String clientID,
                   @FormDataParam("html") String html,
                   @FormDataParam("pdf") InputStream pdfStream) {

    try {
        byte[] pdfByteArray = DocUtils.convertInputStreamToByteArrary(pdfStream);
    } catch (Exception ex) {
        return Response.status(600).entity(ex.getMessage()).build();
    }
}


...

public static byte[] convertInputStreamToByteArrary(InputStream in) throws IOException {
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    final int BUF_SIZE = 1024;
    byte[] buffer = new byte[BUF_SIZE];
    int bytesRead = -1;
    while ((bytesRead = in.read(buffer)) > -1) {
        out.write(buffer, 0, bytesRead);
    }
    in.close();
    byte[] byteArray = out.toByteArray();
    return byteArray;
}