jersey - StreamingOutput as Response entity

Question

I had implemented streaming output in my Jersey Resource class.

@GET @Path("xxxxx") @Produces(BulkConstants.TEXT_XML_MEDIA_TYPE})    public Response getFile() {      FeedReturnStreamingOutput sout = new FeedReturnStreamingOutput();     response = Response.ok(sout).build();     return response; }  class FeedReturnStreamingOutput implements StreamingOutput {      public FeedReturnStreamingOutput()      @Override     public void write(OutputStream outputStream)  {         //write into Output Stream     } } 

The problem is eventhough a response is sent back from the resource before FeedReturnStreamingOutput is called Jersey client waits until FeedReturnStreamingOutput execution is completed.

Client Code :

Client client = Client.create();  ClientResponse response = webResource     //headers     .get(ClientResponse.class);  //The codes underneath executes after FeedReturnStreamingOutput is executed which undermines the necessity of streaming  OutputStream os = new FileOutputStream("c:\\test\\feedoutput5.txt"); System.out.println(new Date() + " : Reached point A");  if (response.getStatus() == 200) {     System.out.println(new Date() + " : Reached point B");     InputStream io = response.getEntityInputStream();      byte[] buff = new byte[1024000];     int count = 0;      while ((count = io.read(buff, 0, buff.length)) != -1) {         os.write(buff, 0, count);     }      os.close();     io.close();  } else {     System.out.println("Response code :" + response.getStatus()); }  System.out.println("Time taken -->> "+(System.currentTimeMillis()-startTime)+" ms"); 

Answer 1

The problem is the buffering OutputStream that Jersey uses to buffer the entity in order to determine the Content-Length header. The size of the buffer default to 8 kb. You disable the buffering if you want, or just change the size of the buffer, with the property

ServerProperties.OUTBOUND_CONTENT_LENGTH_BUFFER

An integer value that defines the buffer size used to buffer server-side response entity in order to determine its size and set the value of HTTP "Content-Length" header.

If the entity size exceeds the configured buffer size, the buffering would be cancelled and the entity size would not be determined. Value less or equal to zero disable the buffering of the entity at all.

This property can be used on the server side to override the outbound message buffer size value - default or the global custom value set using the "jersey.config.contentLength.buffer" global property.

The default value is 8192.

Here's an example

@Path("streaming") public class StreamingResource {      @GET     @Produces("application/octet-stream")     public Response getStream() {         return Response.ok(new FeedReturnStreamingOutput()).build();     }      public static class FeedReturnStreamingOutput implements StreamingOutput {          @Override         public void write(OutputStream output)                 throws IOException, WebApplicationException {             try {                 for (int i = 0; i < 10; i++) {                     output.write(String.format("Hello %d\n", i).getBytes());                     output.flush();                     TimeUnit.MILLISECONDS.sleep(500);                 }             } catch (InterruptedException e) {  throw new RuntimeException(e); }         }     } } 

Here's the result without setting the property

And here's the result after setting the property value to 0

public class AppConfig extends ResourceConfig {     public AppConfig() {         ...         property(ServerProperties.OUTBOUND_CONTENT_LENGTH_BUFFER, 0);     } } 

Answer 2

Try invoking outputStream.flush() from the method FeedReturnStreamingOutput.write(...) every X number of bytes written to the output stream or something like that.

I guess the buffer of the connection is not filled with the data you are returning. So the service does not return anything until Jersey invokes outputStream.close().

In my case, I have a service that streams data and I am doing it exactly as you: by returning Response.ok(<instance of StreamingOutput>).build();.

My service returns data from a database and I invoke outputStream.flush() after writing each row to the output stream.

I know that the service streams data because I can see the client begins receiving data before the service has finished sending the entire result.