org.apache.juneau.rest.response

Class StreamableHandler

java.lang.Object

org.apache.juneau.rest.response.StreamableHandler

All Implemented Interfaces:

ResponseHandler

public final class StreamableHandler
extends Object
implements ResponseHandler

Response handler for Writable and ReaderResource objects.

Uses the Writable.writeTo(Writer) method to send the contents to the RestResponse.getNegotiatedWriter() writer.

See Also:

• Overview > juneau-rest-server > Method Return Types

Constructor Summary

Constructors

Constructor and Description
StreamableHandler()

Method Summary

Modifier and Type	Method and Description
boolean	handle(RestRequest req, RestResponse res, Object output) Process this response if possible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamableHandler

public StreamableHandler()

Method Detail

handle

public boolean handle(RestRequest req,
                      RestResponse res,
                      Object output)
               throws IOException,
                      RestException

Description copied from interface: ResponseHandler

Process this response if possible. This method should return false if it wasn't able to process the response.

Specified by:

handle in interface ResponseHandler

Parameters:

req - The HTTP servlet request.

res - The HTTP servlet response;

output - The POJO returned by the REST method that now needs to be sent to the response.

Returns:

true If this handler handled the response.

Throws:

IOException - If low-level exception occurred on output stream. Results in a HttpServletResponse.SC_INTERNAL_SERVER_ERROR error.

RestException - If some other exception occurred. Can be used to provide an appropriate HTTP response code and message.