Module jakarta.ws.rs

Package jakarta.ws.rs.core

Interface StreamingOutput

public interface StreamingOutput

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 MessageBodyWriter.

Since:

1.0

Author:

Paul Sandoz, Marc Hadley

See Also:

• MessageBodyWriter
• Response

Method Summary

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

Method Details

write

void write(OutputStream output)
    throws IOException,
WebApplicationException

Called to write the message body.

Parameters:

output - the OutputStream to write to.

Throws:

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.