jakarta.ws.rs.core

public Interface StreamingOutput

Imports: java.io.IOException, .OutputStream, jakarta.ws.rs.WebApplicationException

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 jakarta.ws.rs.ext.MessageBodyWriter.

Authors: Paul Sandoz, Marc Hadley
Since: 1.0
See Also: jakarta.ws.rs.ext.MessageBodyWriter, jakarta.ws.rs.core.Response

Method Summary

Modifier and Type	Method and Description
public void	write(OutputStream the OutputStream to write to. output) Called to write the message body.

Method Detail

write	back to summary
public void write(OutputStream output) throws IOException, WebApplicationException Called to write the message body. Parameters output:OutputStream the OutputStream to write to. Exceptions IOException: if an IO error is encountered WebApplicationException: if a specific HTTP error response needs to be produced. Only effective if thrown prior to any bytes being written to output.

write

back to summary

public void write(OutputStream output) throws IOException, WebApplicationException

Called to write the message body.

Parameters

output:OutputStream: the OutputStream to write to.

Exceptions

IOException:: if an IO error is encountered
WebApplicationException:: if a specific HTTP error response needs to be produced. Only effective if thrown prior to any bytes being written to output.