Class ServletCoreResponse

java.lang.Object
org.eclipse.jetty.ee9.nested.ServletCoreResponse
All Implemented Interfaces:
Content.Sink, Response
public class ServletCoreResponse extends Object implements Response
A HttpServletResponse wrapped as a core Response. All write operations are internally converted to blocking writes on the servlet API.

  • Method Details

    • wrap

      public static Response wrap(Request coreRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse, boolean included)

    • getHeaders

      public HttpFields.Mutable getHeaders()
      Specified by:
      getHeaders in interface Response
      Returns:
      the response HTTP headers

    • getServletResponse

      public jakarta.servlet.http.HttpServletResponse getServletResponse()

    • hasLastWrite

      public boolean hasLastWrite()
      Description copied from interface: Response

      Returns whether the last write has been initiated on the response.

      Specified by:
      hasLastWrite in interface Response
      Returns:
      true if last==true has been passed to Response.write(boolean, ByteBuffer, Callback).

    • isCompletedSuccessfully

      public boolean isCompletedSuccessfully()
      Description copied from interface: Response

      Returns whether the response completed successfully.

      The response HTTP status code, HTTP headers and content have been successfully serialized and sent over the network without errors.

      Specified by:
      isCompletedSuccessfully in interface Response
      Returns:
      whether the response completed successfully

    • isCommitted

      public boolean isCommitted()
      Description copied from interface: Response

      Returns whether this response has already been committed.

      Committing a response means that the HTTP status code and HTTP headers cannot be modified anymore, typically because they have already been serialized and sent over the network.

      Specified by:
      isCommitted in interface Response
      Returns:
      whether this response has already been committed

    • write

      public void write(boolean last, ByteBuffer byteBuffer, Callback callback)
      Description copied from interface: Response

      Writes the given ByteBuffer, notifying the Callback when the write is complete.

      Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Callback and a call to this method.

      The invocation of the passed Callback is serialized with previous calls of this method, so that it is not invoked until any invocation of the callback of a previous call to this method has returned.

      Thus a Callback should not block waiting for a callback of a future call to this method.

      Specified by:
      write in interface Content.Sink
      Specified by:
      write in interface Response
      Parameters:
      last - whether the ByteBuffer is the last to write
      byteBuffer - the ByteBuffer to write
      callback - the callback to notify when the write operation is complete

    • getRequest

      public Request getRequest()
      Specified by:
      getRequest in interface Response
      Returns:
      the Request associated with this Response

    • getStatus

      public int getStatus()
      Specified by:
      getStatus in interface Response
      Returns:
      the response HTTP status code

    • setStatus

      public void setStatus(int code)
      Description copied from interface: Response
      Set the response HTTP status code.
      Specified by:
      setStatus in interface Response
      Parameters:
      code - the response HTTP status code

    • getTrailersSupplier

      public Supplier<HttpFields> getTrailersSupplier()
      Specified by:
      getTrailersSupplier in interface Response
      Returns:
      a supplier for the HTTP trailers

    • setTrailersSupplier

      public void setTrailersSupplier(Supplier<HttpFields> trailers)
      Description copied from interface: Response

      Sets the supplier for the HTTP trailers.

      The method Supplier.get() may be called by the implementation multiple times, so it is important that the same value is returned in every invocation.

      Example:

      // Correct usage.
HttpFields.Mutable trailers = HttpFields.build();
response.setTrailersSupplier(() -> trailers);

// WRONG usage, as the value changes for
// every invocation of supplier.get().
response.setTrailersSupplier(() -> HttpFields.build());
      Specified by:
      setTrailersSupplier in interface Response
      Parameters:
      trailers - a supplier for the HTTP trailers

    • reset

      public void reset()
      Description copied from interface: Response

      Resets this response, clearing the HTTP status code, HTTP headers and HTTP trailers.

      Specified by:
      reset in interface Response

    • writeInterim

      public CompletableFuture<Void> writeInterim(int status, HttpFields headers)
      Description copied from interface: Response

      Writes an HTTP interim response, with the given HTTP status code and HTTP headers.

      It is possible to write more than one interim response, for example in case of HttpStatus.EARLY_HINTS_103.

      The returned CompletableFuture is notified of the result of this write, whether it succeeded or failed.

      Specified by:
      writeInterim in interface Response
      Parameters:
      status - the interim HTTP status code
      headers - the HTTP headers
      Returns:
      a CompletableFuture with the result of the write

    • toString

      public String toString()
      Overrides:
      toString in class Object