public class ResponseWriter extends Object implements ContainerResponseWriter
ContainerResponseWriter
for Servlet containers.
The writer depends on provided AsyncContextDelegate
to support async functionality.ContainerResponseWriter.TimeoutHandler
Constructor and 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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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)
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.
|
public ResponseWriter(boolean useSetStatusOn404, boolean configSetStatusOverSendError, jakarta.servlet.http.HttpServletResponse response, AsyncContextDelegate asyncExt, ScheduledExecutorService timeoutTaskExecutor)
useSetStatusOn404
- true if status should be written explicitly when 404 is returnedconfigSetStatusOverSendError
- if true
method HttpServletResponse.setStatus(int)
is used over
HttpServletResponse.sendError(int, java.lang.String)
response
- original HttpResponseRequestasyncExt
- delegate to use for async features implementationtimeoutTaskExecutor
- Jersey runtime executor used for background execution of timeout
handling tasks.public boolean suspend(long timeOut, TimeUnit timeUnit, ContainerResponseWriter.TimeoutHandler timeoutHandler)
ContainerResponseWriter
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.
suspend
in interface ContainerResponseWriter
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.true
if the suspend operation completed successfully, false
otherwise.ContainerResponseWriter.setSuspendTimeout(long, TimeUnit)
,
ContainerResponseWriter.commit()
public void setSuspendTimeout(long timeOut, TimeUnit timeUnit) throws IllegalStateException
ContainerResponseWriter
setSuspendTimeout
in interface ContainerResponseWriter
timeOut
- time-out value. Value less or equal to 0, indicates that
the processing is suspended indefinitely.timeUnit
- time-out time unit.IllegalStateException
- in case the response writer has not been suspended
yet.public OutputStream writeResponseStatusAndHeaders(long contentLength, ContainerResponse responseContext) throws ContainerException
ContainerResponseWriter
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.
writeResponseStatusAndHeaders
in interface ContainerResponseWriter
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.ContainerException
- if an error occurred when writing out the
status and headers or obtaining the output stream.public void commit()
ContainerResponseWriter
commit
in interface ContainerResponseWriter
ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler)
,
ContainerResponseWriter.failure(Throwable)
public void failure(Throwable error)
ContainerResponseWriter
failure
in interface ContainerResponseWriter
error
- unhandled request processing error.ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler)
,
ContainerResponseWriter.commit()
public boolean enableResponseBuffering()
ContainerResponseWriter
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.
enableResponseBuffering
in interface ContainerResponseWriter
true
to enable entity buffering to be done by Jersey runtime, false
otherwise.public int getResponseStatus()
writeResponseStatusAndHeaders(long, org.glassfish.jersey.server.ContainerResponse)
has been invoked.
The method will block if the write method has not been called yet.public boolean responseContextResolved()
public ContainerResponse getResponseContext()
Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.