org.glassfish.jersey.servlet.internal
Class ResponseWriter

java.lang.Object
  org.glassfish.jersey.servlet.internal.ResponseWriter

All Implemented Interfaces:

ContainerResponseWriter

public class ResponseWriter
extends Object
implements ContainerResponseWriter

An internal implementation of ContainerResponseWriter for Servlet containers. The writer depends on provided AsyncContextDelegate to support async functionality.

Author:

Paul Sandoz (paul.sandoz at oracle.com), Jakub Podlesak (jakub.podlesak at oracle.com), Martin Matula (martin.matula at oracle.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.jersey.server.spi.ContainerResponseWriter

ContainerResponseWriter.TimeoutHandler

Constructor Summary

ResponseWriter(boolean useSetStatusOn404, javax.servlet.http.HttpServletResponse response, AsyncContextDelegate asyncExt, ScheduledExecutorService timeoutTaskExecutor)
Creates a new instance to write a single Jersey response.

Method Summary

void	commit() Commit the response & close the container response writer.
boolean	enableResponseBuffering() Return true if the entity buffering should be enabled in Jersey.
void	failure(Throwable error) Propagate an unhandled error to the I/O container.
int	getResponseStatus() Provides response status captured when writeResponseStatusAndHeaders(long, org.glassfish.jersey.server.ContainerResponse) has been invoked.
void	setSuspendTimeout(long timeOut, TimeUnit timeUnit) Set the suspend timeout.
boolean	suspend(long timeOut, TimeUnit timeUnit, ContainerResponseWriter.TimeoutHandler timeoutHandler) Suspend the request/response processing.
OutputStream	writeResponseStatusAndHeaders(long contentLength, ContainerResponse responseContext) Write the status and headers of the response and return an output stream for the web application to write the entity of the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseWriter

public ResponseWriter(boolean useSetStatusOn404,
                      javax.servlet.http.HttpServletResponse response,
                      AsyncContextDelegate asyncExt,
                      ScheduledExecutorService timeoutTaskExecutor)

Creates a new instance to write a single Jersey response.

Parameters:

useSetStatusOn404 - true if status should be written explicitly when 404 is returned

response - original HttpResponseRequest

asyncExt - delegate to use for async features implementation

timeoutTaskExecutor - Jersey runtime executor used for background execution of timeout handling tasks.

Method Detail

suspend

public boolean suspend(long timeOut,
                       TimeUnit timeUnit,
                       ContainerResponseWriter.TimeoutHandler timeoutHandler)

Description copied from interface: ContainerResponseWriter

Suspend the request/response processing. The method returns true to indicate the response writer was suspended successfully. In case the provider has already been suspended earlier, the method returns false.

I/O container must not automatically commit the response writer when the processing on the I/O container thread is finished and the thread is released. Instead, the Jersey runtime will make sure to manually close the container response writer instance by explicitly calling the ContainerResponseWriter.commit() or ContainerResponseWriter.failure(Throwable) method at some later point in time.

Once suspended, the specified suspend timeout can be further updated using ContainerResponseWriter.setSuspendTimeout(long, java.util.concurrent.TimeUnit) method.

Specified by:

suspend in interface ContainerResponseWriter

Parameters:

timeOut - time-out value. Value less or equal to 0, indicates that the processing is suspended indefinitely.

timeUnit - time-out time unit.

timeoutHandler - time-out handler to process a time-out event if it occurs.

Returns:

true if the suspend operation completed successfully, false otherwise.

See Also:

ContainerResponseWriter.setSuspendTimeout(long, TimeUnit), ContainerResponseWriter.commit()

setSuspendTimeout

public void setSuspendTimeout(long timeOut,
                              TimeUnit timeUnit)
                       throws IllegalStateException

Description copied from interface: ContainerResponseWriter

Set the suspend timeout. Once the container response writer is suspended, the suspend timeout value can be further updated by the method.

Specified by:

setSuspendTimeout in interface ContainerResponseWriter

Parameters:

timeOut - time-out value. Value less or equal to 0, indicates that the processing is suspended indefinitely.

timeUnit - time-out time unit.

Throws:

IllegalStateException - in case the response writer has not been suspended yet.

writeResponseStatusAndHeaders

public OutputStream writeResponseStatusAndHeaders(long contentLength,
                                                  ContainerResponse responseContext)
                                           throws ContainerException

Description copied from interface: ContainerResponseWriter

Write the status and headers of the response and return an output stream for the web application to write the entity of the response.

If the response content length is declared to be greater or equal to 0, it means that the content length in bytes of the entity to be written is known, otherwise -1. I/O containers may use this value to determine whether the "Content-Length" header can be set or utilize chunked transfer encoding.

Specified by:

writeResponseStatusAndHeaders in interface ContainerResponseWriter

Parameters:

contentLength - greater or equal to 0 if the content length in bytes of the entity to be written is known, otherwise -1. Containers may use this value to determine whether the "Content-Length" header can be set or utilize chunked transfer encoding.

responseContext - the JAX-RS response to be written. The status and headers are obtained from the response.

Returns:

the output stream to write the entity (if any).

Throws:

ContainerException - if an error occurred when writing out the status and headers or obtaining the output stream.

commit

public void commit()

Description copied from interface: ContainerResponseWriter

Commit the response & close the container response writer. Indicates to the I/O container that request has been fully processed and response has been fully written. This signals the I/O container to finish the request/response processing, clean up any state, flush any streams, release resources etc.

Specified by:

commit in interface ContainerResponseWriter

See Also:

ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler), ContainerResponseWriter.failure(Throwable)

failure

public void failure(Throwable error)

Description copied from interface: ContainerResponseWriter

Propagate an unhandled error to the I/O container. Indicates to the I/O container that the request processing has finished with an error that could not be processed by the Jersey runtime. The I/O container is expected to process the exception in a container-specific way. This method also signals the I/O container to finish the request/response processing, clean up any state, flush any streams, release resources etc.

Specified by:

failure in interface ContainerResponseWriter

Parameters:

error - unhandled request processing error.

See Also:

ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler), ContainerResponseWriter.commit()

enableResponseBuffering

public boolean enableResponseBuffering()

Description copied from interface: ContainerResponseWriter

Return true if the entity buffering should be enabled in Jersey. If enabled, the outbound entity is buffered by Jersey runtime up to a configured amount of bytes prior to being written to the output stream to determine its size that may be used to set the value of HTTP "Content-Length" header.

Containers that provide it's own solution for determining the message payload size may decide to return false to prevent Jersey from buffering message entities unnecessarily.

Specified by:

enableResponseBuffering in interface ContainerResponseWriter

Returns:

true to enable the entity buffering should by Jersey runtime, false otherwise.

getResponseStatus

public int getResponseStatus()

Provides response status captured when writeResponseStatusAndHeaders(long, org.glassfish.jersey.server.ContainerResponse) has been invoked. The method will block if the write method has not been called yet.

Returns:

response status