Top Description Fields Constructors Methods
com.sun.faces.application

public Class ViewHandlerResponseWrapper

extends HttpServletResponseWrapper
Class Inheritance
Imports
java.io.CharArrayWriter, .IOException, .PrintWriter, .Writer, jakarta.servlet.ServletOutputStream, .ServletResponse, jakarta.servlet.http.HttpServletResponse, .HttpServletResponseWrapper

This class is used by jakarta.faces.application.ViewHandler#createView to obtain the text that exists after the <f:view> tag.

Field Summary

Modifier and TypeField and Description
private ByteArrayWebOutputStream
basos

private CharArrayWriter
caw

private WebPrintWriter
pw

private int
status

Constructor Summary

AccessConstructor and Description
public
ViewHandlerResponseWrapper(HttpServletResponse wrapped)

Method Summary

Modifier and TypeMethod and Description
public void
flushContentToWrappedResponse()

public void
flushToWriter(Writer writer, String encoding)

public byte[]
getBytes()

public char[]
getChars()

public ServletOutputStream
getOutputStream()

Overrides jakarta.servlet.ServletResponseWrapper.getOutputStream.

Implements jakarta.servlet.ServletResponse.getOutputStream.

Returns a ServletOutputStream suitable for writing binary data in the response.

public int
getStatus()

Overrides jakarta.servlet.http.HttpServletResponseWrapper.getStatus.

Implements jakarta.servlet.http.HttpServletResponse.getStatus.

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

public PrintWriter
getWriter()

Overrides jakarta.servlet.ServletResponseWrapper.getWriter.

Implements jakarta.servlet.ServletResponse.getWriter.

Returns a PrintWriter object that can send character text to the client.

public boolean
isBytes()

public boolean
isChars()

public void
resetBuffers()

public void
sendError(int
the error status code
sc, String
the descriptive message
msg)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

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

public void
sendError(int
the error status code
sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

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

public void
setStatus(int
the status code
sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setStatus.

Implements jakarta.servlet.http.HttpServletResponse.setStatus.

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

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from jakarta.servlet.http.HttpServletResponseWrapper:
addCookieaddDateHeaderaddHeaderaddIntHeadercontainsHeaderencodeRedirectURLencodeURLgetHeadergetHeaderNamesgetHeadersgetTrailerFieldssendRedirectsendRedirectsendRedirectsendRedirectsetDateHeadersetHeadersetIntHeadersetTrailerFields

Field Detail

basosback to summary
private ByteArrayWebOutputStream basos
cawback to summary
private CharArrayWriter caw
pwback to summary
private WebPrintWriter pw
statusback to summary
private int status

Constructor Detail

ViewHandlerResponseWrapperback to summary
public ViewHandlerResponseWrapper(HttpServletResponse wrapped)

Method Detail

flushContentToWrappedResponseback to summary
public void flushContentToWrappedResponse() throws IOException
flushToWriterback to summary
public void flushToWriter(Writer writer, String encoding) throws IOException
getBytesback to summary
public byte[] getBytes()
getCharsback to summary
public char[] getChars()
getOutputStreamback to summary
public ServletOutputStream getOutputStream() throws IOException

Overrides jakarta.servlet.ServletResponseWrapper.getOutputStream.

Implements jakarta.servlet.ServletResponse.getOutputStream.

Doc from jakarta.servlet.ServletResponse.getOutputStream.

Returns a ServletOutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

Calling flush() on the ServletOutputStream commits the response. Either this method or getWriter may be called to write the body, not both, except when reset has been called.

Returns:ServletOutputStream

a ServletOutputStream for writing binary data

Annotations
@Override
Exceptions
IOException:
if an input or output exception occurred
getStatusback to summary
public int getStatus()

Overrides jakarta.servlet.http.HttpServletResponseWrapper.getStatus.

Implements jakarta.servlet.http.HttpServletResponse.getStatus.

Doc from jakarta.servlet.http.HttpServletResponseWrapper.getStatus.

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

Returns:int

the current status code of the wrapped response

Annotations
@Override
getWriterback to summary
public PrintWriter getWriter() throws IOException

Overrides jakarta.servlet.ServletResponseWrapper.getWriter.

Implements jakarta.servlet.ServletResponse.getWriter.

Doc from jakarta.servlet.ServletResponse.getWriter.

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by getCharacterEncoding. If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Calling flush() on the PrintWriter commits the response.

Either this method or getOutputStream may be called to write the body, not both, except when reset has been called.

Returns:PrintWriter

a PrintWriter object that can return character data to the client

Annotations
@Override
Exceptions
IOException:
if an input or output exception occurred
isBytesback to summary
public boolean isBytes()
isCharsback to summary
public boolean isChars()
resetBuffersback to summary
public void resetBuffers() throws IOException
sendErrorback to summary
public void sendError(int sc, String msg) throws IOException

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Doc from jakarta.servlet.http.HttpServletResponseWrapper.sendError.

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

Parameters
sc:int

Doc from jakarta.servlet.http.HttpServletResponse.sendError.

the error status code

msg:String

Doc from jakarta.servlet.http.HttpServletResponse.sendError.

the descriptive message

Annotations
@Override
Exceptions
IOException:

Doc from jakarta.servlet.http.HttpServletResponse.sendError.

If an input or output exception occurs

sendErrorback to summary
public void sendError(int sc) throws IOException

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Doc from jakarta.servlet.http.HttpServletResponseWrapper.sendError.

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

Parameters
sc:int

Doc from jakarta.servlet.http.HttpServletResponse.sendError.

the error status code

Annotations
@Override
Exceptions
IOException:

Doc from jakarta.servlet.http.HttpServletResponse.sendError.

If an input or output exception occurs

setStatusback to summary
public void setStatus(int sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setStatus.

Implements jakarta.servlet.http.HttpServletResponse.setStatus.

Doc from jakarta.servlet.http.HttpServletResponseWrapper.setStatus.

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

Parameters
sc:int

Doc from jakarta.servlet.http.HttpServletResponse.setStatus.

the status code

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override