Module cloud.piranha.webapp.api

Package cloud.piranha.webapp.api

Interface WebApplicationResponse

All Superinterfaces:

HttpServletResponse, ServletResponse

All Known Implementing Classes:

DefaultWebApplicationResponse, EmbeddedResponse, HttpWebApplicationResponse, NanoResponse

public interface WebApplicationResponse
extends 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.
java.util.Collection<Cookie>	getCookies()	Get the cookies.
java.lang.Runnable	getResponseCloser()	Get the response closer.
java.io.OutputStream	getUnderlyingOutputStream()	Get the underlying output stream.
void	setResponseCloser(java.lang.Runnable responseCloser)	Set the response closer.
void	setUnderlyingOutputStream(java.io.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, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, 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

java.util.Collection<Cookie> getCookies()

Get the cookies.

Returns:

the cookies.

getResponseCloser

java.lang.Runnable getResponseCloser()

Get the response closer.

Returns:

the response closer.

getUnderlyingOutputStream

java.io.OutputStream getUnderlyingOutputStream()

Get the underlying output stream.

Returns:

the underlying output stream.

setUnderlyingOutputStream

void setUnderlyingOutputStream(java.io.OutputStream outputStream)

Set the underlying output stream.

Parameters:

outputStream - the underlying output stream.

writeHeaders

void writeHeaders()
           throws java.io.IOException

Write the headers.

Throws:

java.io.IOException - when an I/O error occurs.

writeStatusLine

void writeStatusLine()
              throws java.io.IOException

Write the status line.

Throws:

java.io.IOException - when an I/O error occurs.

setWebApplication

void setWebApplication(WebApplication webApplication)

Set the web application.

Parameters:

webApplication - the web application.

setResponseCloser

void setResponseCloser(java.lang.Runnable responseCloser)

Set the response closer.

Parameters:

responseCloser - the response closer.