Class ResponseWriter

    • Field Detail

      • LOGGER

        private static final java.util.logging.Logger LOGGER
      • response

        private final javax.servlet.http.HttpServletResponse response
      • configSetStatusOverSendError

        private final boolean configSetStatusOverSendError
        Cached value of configuration property ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERROR. If true method HttpServletResponse.setStatus(int) is used over HttpServletResponse.sendError(int, java.lang.String).
      • responseContext

        private final java.util.concurrent.CompletableFuture<ContainerResponse> responseContext
    • Constructor Detail

      • ResponseWriter

        public ResponseWriter​(boolean useSetStatusOn404,
                              boolean configSetStatusOverSendError,
                              javax.servlet.http.HttpServletResponse response,
                              AsyncContextDelegate asyncExt,
                              java.util.concurrent.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 Detail

      • setSuspendTimeout

        public void setSuspendTimeout​(long timeOut,
                                      java.util.concurrent.TimeUnit timeUnit)
                               throws java.lang.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:
        java.lang.IllegalStateException - in case the response writer has not been suspended yet.
      • writeResponseStatusAndHeaders

        public java.io.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.
      • callSendError

        private void callSendError()
        According to configuration and response processing status it calls HttpServletResponse.sendError(int, String) over common HttpServletResponse.setStatus(int).
      • failure

        public void failure​(java.lang.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 entity buffering to be done by Jersey runtime, false otherwise.
      • rethrow

        private void rethrow​(java.lang.Throwable error)
        Rethrow the original exception as required by JAX-RS, 3.3.4
        Parameters:
        error - throwable to be re-thrown
      • responseContextResolved

        public boolean responseContextResolved()