Module jakarta.faces

Package com.sun.faces.application

Class ViewHandlerResponseWrapper

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

com.sun.faces.application.ViewHandlerResponseWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class ViewHandlerResponseWrapper
extends HttpServletResponseWrapper

This class is used by ViewHandler.createView(jakarta.faces.context.FacesContext, java.lang.String) to obtain the text that exists after the <f:view> tag.

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_MISDIRECTED_REQUEST, 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_PERMANENT_REDIRECT, 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_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY

Constructor Summary

Constructors

Constructor	Description
ViewHandlerResponseWrapper(HttpServletResponse wrapped)

Method Summary

Modifier and Type	Method	Description
void	flushContentToWrappedResponse()
void	flushToWriter(Writer writer, String encoding)
byte[]	getBytes()
char[]	getChars()
ServletOutputStream	getOutputStream()	The default behavior of this method is to return getOutputStream() on the wrapped response object.
int	getStatus()	The default behaviour of this method is to call HttpServletResponse.getStatus() on the wrapped response object.
PrintWriter	getWriter()	The default behavior of this method is to return getWriter() on the wrapped response object.
boolean	isBytes()
boolean	isChars()
void	resetBuffers()
void	sendError(int sc)	The default behavior of this method is to call sendError(int sc) on the wrapped response object.
void	sendError(int sc, String msg)	The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
void	setStatus(int sc)	The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
String	toString()

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

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

Methods inherited from class jakarta.servlet.ServletResponseWrapper

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.ServletResponse

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

Constructor Details

ViewHandlerResponseWrapper

public ViewHandlerResponseWrapper(HttpServletResponse wrapped)

Method Details

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Parameters:

sc - the error status code

msg - the descriptive message

Throws:

IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws IOException

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call sendError(int sc) on the wrapped response object.

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Parameters:

sc - the error status code

Throws:

IOException - If an input or output exception occurs

setStatus

public void setStatus(int sc)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

Specified by:

setStatus in interface HttpServletResponse

Overrides:

setStatus in class HttpServletResponseWrapper

Parameters:

sc - the status code

See Also:

• HttpServletResponse.sendError(int, java.lang.String)

getStatus

public int getStatus()

Description copied from class: HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getStatus() on the wrapped response object.

Specified by:

getStatus in interface HttpServletResponse

Overrides:

getStatus in class HttpServletResponseWrapper

Returns:

the current status code of the wrapped response

isBytes

public boolean isBytes()

isChars

public boolean isChars()

getBytes

public byte[] getBytes()

getChars

public char[] getChars()

toString

public String toString()

Overrides:

toString in class Object

flushContentToWrappedResponse

public void flushContentToWrappedResponse()
                                   throws IOException

Throws:

IOException

flushToWriter

public void flushToWriter(Writer writer,
 String encoding)
                   throws IOException

Throws:

IOException

resetBuffers

public void resetBuffers()
                  throws IOException

Throws:

IOException

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getOutputStream() on the wrapped response object.

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Returns:

a ServletOutputStream for writing binary data

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getWriter()
• ServletResponse.reset()

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getWriter() on the wrapped response object.

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Returns:

a PrintWriter object that can return character data to the client

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getOutputStream()
• ServletResponse.setCharacterEncoding(java.lang.String)
• ServletResponse.reset()