Skip to main content

Jersey streaming binary data

In the previous post I showed how you can post binary data to a jersey REST api. You can also use Jersey to serve files, although its better done by apache or nginx but sometimes you might want to serve thumbnails stored in a database out of a service and put varnish in front of the REST api to cache the thumbnails. This is just a demonstration of using jersey to serve binary data in streaming fashion.

@Path("/download-service")
public class DownaloadService extends SecureRestService {
 private static final AppLogger logger  = AppLogger.getLogger(DownaloadService.class);

 @POST
 @Produces(MediaType.APPLICATION_OCTET_STREAM)
 public StreamingOutput getThumbnail(
   @FormParam("securityKey") final String securityKey,
   @FormParam("guid") final String guid) throws JSONException {
  return new StreamingOutput() {
   @Override
   public void write(OutputStream out) throws IOException {
    try {
     if (!isAuthorized(securityKey)) {
      response.sendError(HttpServletResponse.SC_UNAUTHORIZED);
     } else {
      //Read thumbnail out of database and dovetail both streams(IOUtils.copy) to directly stream to the response without storing them in memory.
     }
    } catch (Throwable t) {
     logger.error(t);
     response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, t.getMessage());
    }
   }
  };
 }
}


To test this code you can again use Jersey client api and to verify against response status or data you can use the ClientResponse class as shown below

  Form form = new Form();
  form.add("securityKey", getSecureToken());
  form.add("guid", guid);

  ClientResponse response = webResource.path(
    "download-service").post(ClientResponse.class, form);
  Assert.assertNotEquals(HttpServletResponse.SC_NOT_AUTHORIZED, response.getStatus());

  ByteArrayOutputStream bos = new ByteArrayOutputStream();
  IOUtils.copy(response.getEntityInputStream(), bos);
  byte[] result = bos.toByteArray();
  Assert.assertArrayEquals(expected, result);

Comments

  1. You saved my day! Many many thanks! :)

    ReplyDelete
  2. This is a very useful bit, thank you:

    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    IOUtils.copy(response.getEntityInputStream(), bos);
    byte[] result = bos.toByteArray();

    ReplyDelete
  3. With "streaming" you are talking about HTTP completed upload/download to/from a server, right?! :)

    ReplyDelete
    Replies
    1. Yes complete download from a rest api. Upload is also similar.

      Delete
  4. I need to stream records as they are available. Hence i have


    import java.io.BufferedWriter;
    import java.io.IOException;
    import java.io.OutputStream;
    import java.io.OutputStreamWriter;
    import java.io.Writer;

    import javax.ws.rs.core.StreamingOutput;

    import org.apache.log4j.Logger;

    public class StreamingOutputImpl extends RetrieverResource implements StreamingOutput {
    private static final Logger LOGGER = Logger.getLogger(StreamingOutputImpl.class);
    private OutputStream os;

    public StreamingOutputImpl(final RequestParameters parameters, final String basePath) {
    super(parameters, basePath);
    }

    @Override
    public void write(final OutputStream os) throws IOException {
    this.os = os;
    read();
    }

    @Override
    public void writeRecord(final GenericRecord record) {
    try {
    Writer writer = new BufferedWriter(new OutputStreamWriter(os));
    writer.write(record.toString());
    writer.flush();
    } catch (final IOException e) {
    LOGGER.error("Error while write record " + record, e);
    }
    }
    }

    Assuming i have 100 records, and writeRecord() is invoked 100 times. I see the output in browser (with @GET and @POST) only after 100 th record and not after every record.

    Any suggestions?

    ReplyDelete
  5. How to implement the client in Jersey 2?

    ReplyDelete
  6. Just return the byte[] as entity works for me.

    ReplyDelete
    Replies
    1. for documents < 2GB yes, but for streaming data (a radio program that runs 24/7 for years for example) this would not be sufficient.

      Delete
  7. ByteArrayOutputStream bos = new ByteArrayOutputStream();
    IOUtils.copy(response.getEntityInputStream(), bos);
    byte[] result = bos.toByteArray();

    YOU SIMPLY SAVED ME!!! Thanks a lot!!!

    ReplyDelete

Post a Comment

Popular posts from this blog

Haproxy and tomcat JSESSIONID

One of the biggest problems I have been trying to solve at our startup is to put our tomcat nodes in HA mode. Right now if a customer comes, he lands on to a node and remains there forever. This has two major issues: 1) We have to overprovision each node with ability to handle worse case capacity. 2) If two or three high profile customers lands on to same node then we need to move them manually. 3) We need to cut over new nodes and we already have over 100+ nodes.  Its a pain managing these nodes and I waste lot of my time in chasing node specific issues. I loath when I know I have to chase this env issue. I really hate human intervention as if it were up to me I would just automate thing and just enjoy the fruits of automation and spend quality time on major issues rather than mundane task,call me lazy but thats a good quality. So Finally now I am at a stage where I can put nodes behing HAProxy in QA env. today we were testing the HA config and first problem I immediat...

Adding Jitter to cache layer

Thundering herd is an issue common to webapp that rely on heavy caching where if lots of items expire at the same time due to a server restart or temporal event, then suddenly lots of calls will go to database at same time. This can even bring down the database in extreme cases. I wont go into much detail but the app need to do two things solve this issue. 1) Add consistent hashing to cache layer : This way when a memcache server is added/removed from the pool, entire cache is not invalidated.  We use memcahe from both python and Java layer and I still have to find a consistent caching solution that is portable across both languages. hash_ring and spymemcached both use different points for server so need to read/test more. 2) Add a jitter to cache or randomise the expiry time: We expire long term cache  records every 8 hours after that key was added and short term cache expiry is 2 hours. As our customers usually comes to work in morning and access the cloud file server it ...

Spring 3.2 quartz 2.1 Jobs added with no trigger must be durable.

I am trying to enable HA on nodes and in that process I found that in a two test node setup a job that has a frequency of 10 sec was running into deadlock. So I tried upgrading from Quartz 1.8 to 2.1 by following the migration guide but I ran into an exception that says "Jobs added with no trigger must be durable.". After looking into spring and Quartz code I figured out that now Quartz is more strict and earlier the scheduler.addJob had a replace parameter which if passed to true would skip the durable check, in latest quartz this is fixed but spring hasnt caught up to this. So what do you do, well I jsut inherited the factory and set durability to true and use that public class DurableJobDetailFactoryBean extends JobDetailFactoryBean {     public DurableJobDetailFactoryBean() {         setDurability(true);     } } and used this instead of JobDetailFactoryBean in the spring bean definition     <bean i...