Module org.glassfish.jersey.container.servlet

Package 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, Jakub Podlesak, Martin Matula, Libor Kramolis

Nested Class Summary

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

ContainerResponseWriter.TimeoutHandler

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	commit()
boolean	enableResponseBuffering()
void	failure(Throwable error)
ContainerResponse	getResponseContext()
int	getResponseStatus()	Provides response status captured when writeResponseStatusAndHeaders(long, org.glassfish.jersey.server.ContainerResponse) has been invoked.
boolean	responseContextResolved()
void	setSuspendTimeout(long timeOut, TimeUnit timeUnit)
boolean	suspend(long timeOut, TimeUnit timeUnit, ContainerResponseWriter.TimeoutHandler timeoutHandler)
OutputStream	writeResponseStatusAndHeaders(long contentLength, ContainerResponse responseContext)

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseWriter

public ResponseWriter(boolean useSetStatusOn404,
 boolean configSetStatusOverSendError,
 jakarta.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

configSetStatusOverSendError - if true method HttpServletResponse.setStatus(int) is used over HttpServletResponse.sendError(int, java.lang.String)

response - original HttpResponseRequest

asyncExt - delegate to use for async features implementation

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

Method Details

suspend

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

Specified by:

suspend in interface ContainerResponseWriter

setSuspendTimeout

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

Specified by:

setSuspendTimeout in interface ContainerResponseWriter

Throws:

IllegalStateException

writeResponseStatusAndHeaders

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

Specified by:

writeResponseStatusAndHeaders in interface ContainerResponseWriter

Throws:

ContainerException

commit

public void commit()

Specified by:

commit in interface ContainerResponseWriter

failure

public void failure(Throwable error)

Specified by:

failure in interface ContainerResponseWriter

enableResponseBuffering

public boolean enableResponseBuffering()

Specified by:

enableResponseBuffering in interface ContainerResponseWriter

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

responseContextResolved

public boolean responseContextResolved()

getResponseContext

public ContainerResponse getResponseContext()