org.zkoss.web.servlet.http

Class HttpBufferedResponse

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

org.zkoss.web.servlet.http.HttpBufferedResponse

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse

public class HttpBufferedResponse
extends jakarta.servlet.http.HttpServletResponseWrapper

A servlet response that uses another writer or stream as the output.

Author:

tomyeh

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 and Description
java.lang.String	encodeRedirectUrl(java.lang.String url) Deprecated.
java.lang.String	encodeUrl(java.lang.String url) Deprecated.
void	flushBuffer()
static jakarta.servlet.http.HttpServletResponse	getInstance(jakarta.servlet.http.HttpServletResponse response, java.io.OutputStream stream) Returns a buffered response with a output stream, if stream is not null; or the original response if stream is null.
static jakarta.servlet.http.HttpServletResponse	getInstance(jakarta.servlet.http.HttpServletResponse response, java.io.Writer writer) Returns a buffered response with a writer, if writer is not null; or the original response if writer is null.
jakarta.servlet.ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
boolean	isSendRedirect() Returns whether sendRedirect(java.lang.String) was called.
void	resetBuffer() Useful only if StringWriter or ByteArrayOutputStream is used to construct this object.
void	sendRedirect(java.lang.String location)

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

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

Methods inherited from class jakarta.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.ServletResponse

getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

Method Detail

getInstance

public static final jakarta.servlet.http.HttpServletResponse getInstance(jakarta.servlet.http.HttpServletResponse response,
                                                                       java.io.Writer writer)

Returns a buffered response with a writer, if writer is not null; or the original response if writer is null. It is smart enough not to wrap the same writer twice.

getInstance

public static final jakarta.servlet.http.HttpServletResponse getInstance(jakarta.servlet.http.HttpServletResponse response,
                                                                       java.io.OutputStream stream)

Returns a buffered response with a output stream, if stream is not null; or the original response if stream is null. It is smart enough not to wrap the same stream twice.

isSendRedirect

public boolean isSendRedirect()

Returns whether sendRedirect(java.lang.String) was called.

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Overrides:

getWriter in class jakarta.servlet.ServletResponseWrapper

Throws:

java.io.IOException

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Overrides:

getOutputStream in class jakarta.servlet.ServletResponseWrapper

Throws:

java.io.IOException

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Overrides:

flushBuffer in class jakarta.servlet.ServletResponseWrapper

Throws:

java.io.IOException

resetBuffer

public void resetBuffer()

Useful only if StringWriter or ByteArrayOutputStream is used to construct this object.

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

Overrides:

resetBuffer in class jakarta.servlet.ServletResponseWrapper

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class jakarta.servlet.http.HttpServletResponseWrapper

Throws:

java.io.IOException

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

Deprecated.

Specified by:

encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse

Overrides:

encodeRedirectUrl in class jakarta.servlet.http.HttpServletResponseWrapper

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Deprecated.

Specified by:

encodeUrl in interface jakarta.servlet.http.HttpServletResponse

Overrides:

encodeUrl in class jakarta.servlet.http.HttpServletResponseWrapper