Module cloud.piranha.core.api
Package cloud.piranha.core.api

Interface WebApplicationResponse

All Superinterfaces:
jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
All Known Implementing Classes:
DefaultWebApplicationResponse, EmbeddedResponse, HttpWebApplicationResponse
public interface WebApplicationResponse extends jakarta.servlet.http.HttpServletResponse
The WebApplicationResponse API.
Author:
Manfred Riem ([email protected])

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletResponse

    SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    closeAsyncResponse()
    Close the async response.
    Collection<jakarta.servlet.http.Cookie>
    getCookies()
    Returns the cookies.
    Runnable
    getResponseCloser()
    Returns the response closer.
    OutputStream
    getUnderlyingOutputStream()
    Returns the underlying output stream.
    void
    setResponseCloser(Runnable responseCloser)
    Set the response closer.
    void
    setUnderlyingOutputStream(OutputStream outputStream)
    Set the underlying output stream.
    void
    setWebApplication(WebApplication webApplication)
    Set the web application.
    void
    writeHeaders()
    Write the headers.
    void
    writeStatusLine()
    Write the status line.

    Methods inherited from interface jakarta.servlet.http.HttpServletResponse

    addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields

    Methods inherited from interface jakarta.servlet.ServletResponse

    flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

  • Method Details

    • closeAsyncResponse

      void closeAsyncResponse()
      Close the async response.

    • getCookies

      Collection<jakarta.servlet.http.Cookie> getCookies()
      Returns the cookies.
      Returns:
      the cookies

    • getResponseCloser

      Runnable getResponseCloser()
      Returns the response closer.
      Returns:
      the response closer

    • getUnderlyingOutputStream

      OutputStream getUnderlyingOutputStream()
      Returns the underlying output stream.
      Returns:
      the underlying output stream

    • setUnderlyingOutputStream

      void setUnderlyingOutputStream(OutputStream outputStream)
      Set the underlying output stream.
      Parameters:
      outputStream - the underlying output stream.

    • writeHeaders

      void writeHeaders() throws IOException
      Write the headers.
      Throws:
      IOException - when an I/O error occurs.

    • writeStatusLine

      void writeStatusLine() throws IOException
      Write the status line.
      Throws:
      IOException - when an I/O error occurs.

    • setWebApplication

      void setWebApplication(WebApplication webApplication)
      Set the web application.
      Parameters:
      webApplication - the web application.

    • setResponseCloser

      void setResponseCloser(Runnable responseCloser)
      Set the response closer.
      Parameters:
      responseCloser - the response closer.