Module cloud.piranha.webapp.impl

Package cloud.piranha.webapp.impl

Class DefaultWebApplicationResponse

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

cloud.piranha.webapp.impl.DefaultWebApplicationResponse

All Implemented Interfaces:

WebApplicationResponse, HttpServletResponse, ServletResponse, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

EmbeddedResponse, HttpWebApplicationResponse, NanoResponse

public class DefaultWebApplicationResponse
extends ServletOutputStream
implements WebApplicationResponse

The default WebApplicationResponse.

Author:

Manfred Riem ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	bodyOnly	Stores the body only flag.
protected byte[]	buffer	Stores the buffer.
protected boolean	bufferResetting	Boolean indicating the buffer is resetting.
protected String	characterEncoding	Stores the character encoding.
protected boolean	characterEncodingSet	Stores if the character encoding has been set manually.
protected boolean	committed	Stores the committed flag.
protected String	contentLanguage	Stores the content language
protected long	contentLength	Stores the content length.
protected String	contentType	Stores the content type.
protected boolean	contentTypeSet	Stores if the content type has been set manually.
protected List<Cookie>	cookies	Stores the cookies.
protected boolean	gotOutput	Stores if we acquired the output stream.
protected boolean	gotWriter	Stores if we acquired the writer.
protected DefaultHttpHeaderManager	headerManager	Stores the header manager.
protected int	index	Stores the index.
protected Locale	locale	Stores the locale.
protected OutputStream	outputStream	Stores the output stream.
protected Runnable	responseCloser	Stores the response closer.
protected int	status	Stores the status code.
protected String	statusMessage	Stores the status message.
protected WebApplication	webApplication	Stores the web application.
protected PrintWriter	writer	Stores the writer.

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

Constructor Summary

Constructors

Constructor	Description
DefaultWebApplicationResponse()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)	Adds the cookie.
void	addDateHeader(String name, long date)	Add the date header.
void	addHeader(String name, String value)	Add the header.
void	addIntHeader(String name, int value)	Add the intheader.
void	close()
void	closeAsyncResponse()	Close the async response.
boolean	containsHeader(String name)	Contains the header.
String	encodeRedirectUrl(String url)	Deprecated.
String	encodeRedirectURL(String url)	Encode the redirect URL.
String	encodeUrl(String url)	Deprecated.
String	encodeURL(String url)	Encode the URL.
void	flush()
void	flushBuffer()	Flush the buffer.
int	getBufferSize()	Returns the buffer size.
String	getCharacterEncoding()	Returns the character encoding.
long	getContentLength()	Returns the content length.
String	getContentType()	Returns the content type.
Collection<Cookie>	getCookies()	Returns the cookies.
String	getHeader(String name)	Get the header.
Collection<String>	getHeaderNames()	Returns the header names.
Collection<String>	getHeaders(String name)	Returns the headers.
Locale	getLocale()	Returns the locale.
ServletOutputStream	getOutputStream()	Get the output stream.
Runnable	getResponseCloser()	Returns the response closer.
int	getStatus()	Returns the status.
String	getStatusMessage()	Returns the status message.
OutputStream	getUnderlyingOutputStream()	Returns the underlying output stream.
WebApplication	getWebApplication()	Returns the web application.
PrintWriter	getWriter()	Get the writer.
boolean	isBodyOnly()	Is body only.
boolean	isCommitted()	Is committed.
boolean	isReady()	Is ready for output.
void	reset()	Reset.
void	resetBuffer()	Reset the buffer.
void	sendError(int status)	Sends the error.
void	sendError(int status, String statusMessage)	Send the error.
void	sendRedirect(String location)	Send a redirect.
void	setBodyOnly(boolean bodyOnly)	Set the body only flag.
void	setBufferSize(int bufferSize)	Set the buffer size.
void	setCharacterEncoding(String characterEncoding)	Set the character encoding.
void	setCommitted(boolean committed)	Set the committed.
void	setContentLength(int contentLength)	Set the content length.
void	setContentLengthLong(long contentLength)	Set the content length.
void	setContentType(String type)	Set the content type.
void	setDateHeader(String name, long date)	Set the date header.
void	setHeader(String name, String value)	Set the header.
void	setIntHeader(String name, int value)	Set the int header.
void	setLocale(Locale locale)	Set the locale.
void	setOutputStream(ServletOutputStream outputStream)	Set the output stream.
void	setResponseCloser(Runnable responseCloser)	Set the response closer.
void	setStatus(int status)	Set the status.
void	setStatus(int status, String statusMessage)	Deprecated.
void	setUnderlyingOutputStream(OutputStream outputStream)	Set the underlying output stream.
void	setWebApplication(WebApplication webApplication)	Set the web application.
void	setWriteListener(WriteListener listener)	Set the write listener.
protected void	verifyNotCommitted(String methodName)	Verify we are not committed.
void	write(int integer)
void	writeHeaders()	Write the headers.
void	writeStatusLine()	Write the status line.

Methods inherited from class jakarta.servlet.ServletOutputStream

print, print, print, print, print, print, print, println, println, println, println, println, println, println, println

Methods inherited from class java.io.OutputStream

nullOutputStream, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

getTrailerFields, setTrailerFields

Field Details

bodyOnly

protected boolean bodyOnly

Stores the body only flag.

buffer

protected byte[] buffer

Stores the buffer.

bufferResetting

protected boolean bufferResetting

Boolean indicating the buffer is resetting. When true, all output written will be ignored (thrown away).

characterEncoding

protected String characterEncoding

Stores the character encoding.

characterEncodingSet

protected boolean characterEncodingSet

Stores if the character encoding has been set manually.

committed

protected boolean committed

Stores the committed flag.

contentLength

protected long contentLength

Stores the content length.

contentType

protected String contentType

Stores the content type.

contentTypeSet

protected boolean contentTypeSet

Stores if the content type has been set manually.

cookies

protected List<Cookie> cookies

Stores the cookies.

gotOutput

protected boolean gotOutput

Stores if we acquired the output stream.

gotWriter

protected boolean gotWriter

Stores if we acquired the writer.

headerManager

protected DefaultHttpHeaderManager headerManager

Stores the header manager.

index

protected int index

Stores the index.

locale

protected Locale locale

Stores the locale.

writer

protected PrintWriter writer

Stores the writer.

outputStream

protected OutputStream outputStream

Stores the output stream.

status

protected int status

Stores the status code.

statusMessage

protected String statusMessage

Stores the status message.

webApplication

protected WebApplication webApplication

Stores the web application.

contentLanguage

protected String contentLanguage

Stores the content language

responseCloser

protected Runnable responseCloser

Stores the response closer.

Constructor Details

DefaultWebApplicationResponse

public DefaultWebApplicationResponse()

Constructor.

Method Details

addCookie

public void addCookie(Cookie cookie)

Description copied from interface: HttpServletResponse

Adds the cookie.

Specified by:

addCookie in interface HttpServletResponse

Parameters:

cookie - the cookie.

addDateHeader

public void addDateHeader(String name,
 long date)

Description copied from interface: HttpServletResponse

Add the date header.

Specified by:

addDateHeader in interface HttpServletResponse

Parameters:

name - the name.

date - the date.

addHeader

public void addHeader(String name,
 String value)

Description copied from interface: HttpServletResponse

Add the header.

Specified by:

addHeader in interface HttpServletResponse

Parameters:

name - the name.

value - the value.

addIntHeader

public void addIntHeader(String name,
 int value)

Description copied from interface: HttpServletResponse

Add the intheader.

Specified by:

addIntHeader in interface HttpServletResponse

Parameters:

name - the name.

value - the value.

containsHeader

public boolean containsHeader(String name)

Description copied from interface: HttpServletResponse

Contains the header.

Specified by:

containsHeader in interface HttpServletResponse

Parameters:

name - the name.

Returns:

true if it contains the given header, false otherwise.

encodeRedirectURL

public String encodeRedirectURL(String url)

Description copied from interface: HttpServletResponse

Encode the redirect URL.

Specified by:

encodeRedirectURL in interface HttpServletResponse

Parameters:

url - the redirect URL.

Returns:

the encoded redirect URL.

encodeRedirectUrl

@Deprecated
public String encodeRedirectUrl(String url)

Deprecated.

Description copied from interface: HttpServletResponse

Encode the redirect URL.

Specified by:

encodeRedirectUrl in interface HttpServletResponse

Parameters:

url - the redirect URL.

Returns:

the encoded redirect URL.

encodeURL

public String encodeURL(String url)

Description copied from interface: HttpServletResponse

Encode the URL.

Specified by:

encodeURL in interface HttpServletResponse

Parameters:

url - the URL.

Returns:

the encoded URL.

encodeUrl

@Deprecated
public String encodeUrl(String url)

Deprecated.

Description copied from interface: HttpServletResponse

Encode the URL.

Specified by:

encodeUrl in interface HttpServletResponse

Parameters:

url - the URL.

Returns:

the encoded URL.

flushBuffer

public void flushBuffer()
                 throws IOException

Description copied from interface: ServletResponse

Flush the buffer.

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException - when an I/O error occurs.

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: ServletResponse

Returns the character encoding.

Specified by:

getCharacterEncoding in interface ServletResponse

Returns:

the character encoding

getBufferSize

public int getBufferSize()

Description copied from interface: ServletResponse

Returns the buffer size.

Specified by:

getBufferSize in interface ServletResponse

Returns:

the buffer size

getContentLength

public long getContentLength()

Returns the content length.

Returns:

the content length

getContentType

public String getContentType()

Description copied from interface: ServletResponse

Returns the content type.

Specified by:

getContentType in interface ServletResponse

Returns:

the content type

getHeader

public String getHeader(String name)

Description copied from interface: HttpServletResponse

Get the header.

Specified by:

getHeader in interface HttpServletResponse

Parameters:

name - the name.

Returns:

the value, or null if not found.

getHeaderNames

public Collection<String> getHeaderNames()

Description copied from interface: HttpServletResponse

Returns the header names.

Specified by:

getHeaderNames in interface HttpServletResponse

Returns:

the header names

getHeaders

public Collection<String> getHeaders(String name)

Description copied from interface: HttpServletResponse

Returns the headers.

Specified by:

getHeaders in interface HttpServletResponse

Parameters:

name - the name.

Returns:

the headers

getLocale

public Locale getLocale()

Description copied from interface: ServletResponse

Returns the locale.

Specified by:

getLocale in interface ServletResponse

Returns:

the locale

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Description copied from interface: ServletResponse

Get the output stream.

Specified by:

getOutputStream in interface ServletResponse

Returns:

the output stream.

Throws:

IOException - when an I/O error occurs.

getStatus

public int getStatus()

Description copied from interface: HttpServletResponse

Returns the status.

Specified by:

getStatus in interface HttpServletResponse

Returns:

the status

getStatusMessage

public String getStatusMessage()

Returns the status message.

Returns:

the status message

getWebApplication

public WebApplication getWebApplication()

Returns the web application.

Returns:

the web application

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from interface: ServletResponse

Get the writer.

Specified by:

getWriter in interface ServletResponse

Returns:

the writer.

Throws:

IOException - when an I/O error occurs.

isBodyOnly

public boolean isBodyOnly()

Is body only.

Returns:

true if we are only sending the body, false otherwise.

isCommitted

public boolean isCommitted()

Description copied from interface: ServletResponse

Is committed.

Specified by:

isCommitted in interface ServletResponse

Returns:

true if it is, false otherwise.

reset

public void reset()

Description copied from interface: ServletResponse

Reset.

Specified by:

reset in interface ServletResponse

resetBuffer

public void resetBuffer()

Description copied from interface: ServletResponse

Reset the buffer.

Specified by:

resetBuffer in interface ServletResponse

sendError

public void sendError(int status)
               throws IOException

Description copied from interface: HttpServletResponse

Sends the error.

Specified by:

sendError in interface HttpServletResponse

Parameters:

status - the status code.

Throws:

IOException - when an I/O error occurs.

sendError

public void sendError(int status,
 String statusMessage)
               throws IOException

Description copied from interface: HttpServletResponse

Send the error.

Specified by:

sendError in interface HttpServletResponse

Parameters:

status - the status code.

statusMessage - the message.

Throws:

IOException - when an I/O error occurs.

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Description copied from interface: HttpServletResponse

Send a redirect.

Specified by:

sendRedirect in interface HttpServletResponse

Parameters:

location - the location.

Throws:

IOException - when an I/O error occurs.

setBodyOnly

public void setBodyOnly(boolean bodyOnly)

Set the body only flag.

Parameters:

bodyOnly - flag.

setBufferSize

public void setBufferSize(int bufferSize)

Description copied from interface: ServletResponse

Set the buffer size.

Specified by:

setBufferSize in interface ServletResponse

Parameters:

bufferSize - the buffer size.

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Description copied from interface: ServletResponse

Set the character encoding.

Specified by:

setCharacterEncoding in interface ServletResponse

Parameters:

characterEncoding - the character encoding.

setCommitted

public void setCommitted(boolean committed)

Set the committed.

Parameters:

committed - the committed flag.

setContentLength

public void setContentLength(int contentLength)

Description copied from interface: ServletResponse

Set the content length.

Specified by:

setContentLength in interface ServletResponse

Parameters:

contentLength - the content length.

setContentLengthLong

public void setContentLengthLong(long contentLength)

Description copied from interface: ServletResponse

Set the content length.

Specified by:

setContentLengthLong in interface ServletResponse

Parameters:

contentLength - the content length.

setContentType

public void setContentType(String type)

Description copied from interface: ServletResponse

Set the content type.

Specified by:

setContentType in interface ServletResponse

Parameters:

type - the content type.

setDateHeader

public void setDateHeader(String name,
 long date)

Description copied from interface: HttpServletResponse

Set the date header.

Specified by:

setDateHeader in interface HttpServletResponse

Parameters:

name - the name.

date - the date.

setHeader

public void setHeader(String name,
 String value)

Description copied from interface: HttpServletResponse

Set the header.

Specified by:

setHeader in interface HttpServletResponse

Parameters:

name - the name.

value - the value.

setIntHeader

public void setIntHeader(String name,
 int value)

Description copied from interface: HttpServletResponse

Set the int header.

Specified by:

setIntHeader in interface HttpServletResponse

Parameters:

name - the name.

value - the value.

setLocale

public void setLocale(Locale locale)

Description copied from interface: ServletResponse

Set the locale.

Specified by:

setLocale in interface ServletResponse

Parameters:

locale - the locale.

setOutputStream

public void setOutputStream(ServletOutputStream outputStream)

Set the output stream.

Parameters:

outputStream - the output stream.

setStatus

public void setStatus(int status)

Description copied from interface: HttpServletResponse

Set the status.

Specified by:

setStatus in interface HttpServletResponse

Parameters:

status - the status.

setStatus

@Deprecated
public void setStatus(int status,
 String statusMessage)

Deprecated.

Description copied from interface: HttpServletResponse

Set the status.

Specified by:

setStatus in interface HttpServletResponse

Parameters:

status - the status.

statusMessage - the message.

setWebApplication

public void setWebApplication(WebApplication webApplication)

Description copied from interface: WebApplicationResponse

Set the web application.

Specified by:

setWebApplication in interface WebApplicationResponse

Parameters:

webApplication - the web application.

verifyNotCommitted

protected void verifyNotCommitted(String methodName)

Verify we are not committed.

Parameters:

methodName - the method we are checking for.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

closeAsyncResponse

public void closeAsyncResponse()

Description copied from interface: WebApplicationResponse

Close the async response.

Specified by:

closeAsyncResponse in interface WebApplicationResponse

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

getCookies

public Collection<Cookie> getCookies()

Description copied from interface: WebApplicationResponse

Returns the cookies.

Specified by:

getCookies in interface WebApplicationResponse

Returns:

the cookies

getUnderlyingOutputStream

public OutputStream getUnderlyingOutputStream()

Description copied from interface: WebApplicationResponse

Returns the underlying output stream.

Specified by:

getUnderlyingOutputStream in interface WebApplicationResponse

Returns:

the underlying output stream

isReady

public boolean isReady()

Description copied from class: ServletOutputStream

Is ready for output.

Specified by:

isReady in class ServletOutputStream

Returns:

true if it is, false otherwise.

setUnderlyingOutputStream

public final void setUnderlyingOutputStream(OutputStream outputStream)

Description copied from interface: WebApplicationResponse

Set the underlying output stream.

Specified by:

setUnderlyingOutputStream in interface WebApplicationResponse

Parameters:

outputStream - the underlying output stream.

setWriteListener

public void setWriteListener(WriteListener listener)

Description copied from class: ServletOutputStream

Set the write listener.

Specified by:

setWriteListener in class ServletOutputStream

Parameters:

listener - the write listener.

write

public void write(int integer)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

writeHeaders

public void writeHeaders()
                  throws IOException

Description copied from interface: WebApplicationResponse

Write the headers.

Specified by:

writeHeaders in interface WebApplicationResponse

Throws:

IOException - when an I/O error occurs.

writeStatusLine

public void writeStatusLine()
                     throws IOException

Description copied from interface: WebApplicationResponse

Write the status line.

Specified by:

writeStatusLine in interface WebApplicationResponse

Throws:

IOException - when an I/O error occurs.

getResponseCloser

public Runnable getResponseCloser()

Description copied from interface: WebApplicationResponse

Returns the response closer.

Specified by:

getResponseCloser in interface WebApplicationResponse

Returns:

the response closer

setResponseCloser

public void setResponseCloser(Runnable responseCloser)

Description copied from interface: WebApplicationResponse

Set the response closer.

Specified by:

setResponseCloser in interface WebApplicationResponse

Parameters:

responseCloser - the response closer.