Interface AsyncStreamingOutput

public interface AsyncStreamingOutput
A type that may be used as a resource method return value or as the entity in a Response when the application wishes to stream the output. This is a lightweight alternative to a AsyncMessageBodyWriter.
Author:
Paul Sandoz, Marc Hadley
See Also:

  • Method Details

    • asyncWrite

      CompletionStage<Void> asyncWrite(AsyncOutputStream output)
      Called to write the message body.
      Parameters:
      output - the OutputStream to write to.
      Throws:
      IOException - if an IO error is encountered
      jakarta.ws.rs.WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to any bytes being written to output.