Module com.aoapps.servlet.subrequest

Package com.aoapps.servlet.subrequest

Class ServletSubResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

com.aoapps.servlet.subrequest.ServletSubResponseWrapper

All Implemented Interfaces:

IServletSubResponse, ServletResponse

Direct Known Subclasses:

HttpServletSubResponseWrapper

public class ServletSubResponseWrapper
extends ServletResponseWrapper
implements IServletSubResponse

Wraps a servlet response with the intent to operate as a concurrent sub response. Any changes made to the response will only affect this response and will not be passed along to the wrapped response.

The wrapped response may change state while this sub response is being processed. Any changes to the wrapped response will not affect this concurrent sub response.

This class is not thread safe.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	committed

Constructor Summary

Constructors

Constructor	Description
ServletSubResponseWrapper(ServletResponse resp, TempFileContext tempFileContext)

Method Summary

Modifier and Type	Method	Description
void	flushBuffer()
int	getBufferSize()
BufferResult	getCapturedOut()	Gets the captured output.
String	getCharacterEncoding()
String	getContentType()
Locale	getLocale()
ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String type)
void	setLocale(Locale loc)

Methods inherited from class javax.servlet.ServletResponseWrapper

getResponse, isWrapperFor, isWrapperFor, setResponse

Methods inherited from class java.lang.Object

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

Field Details

committed

protected boolean committed

Constructor Details

ServletSubResponseWrapper

public ServletSubResponseWrapper(ServletResponse resp,
 TempFileContext tempFileContext)

Parameters:

tempFileContext - The temp file list for auto temp files.

Method Details

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface ServletResponse

Overrides:

setCharacterEncoding in class ServletResponseWrapper

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

Overrides:

getCharacterEncoding in class ServletResponseWrapper

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Throws:

IOException

getCapturedOut

public BufferResult getCapturedOut()
                            throws IOException

Description copied from interface: IServletSubResponse

Gets the captured output. This closes the associated capturing writer. Any subsequent writes will create a new buffer.

Specified by:

getCapturedOut in interface IServletSubResponse

Throws:

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface ServletResponse

Overrides:

setContentLength in class ServletResponseWrapper

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface ServletResponse

Overrides:

setContentLengthLong in class ServletResponseWrapper

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface ServletResponse

Overrides:

setContentType in class ServletResponseWrapper

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

Overrides:

getContentType in class ServletResponseWrapper

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

Overrides:

setBufferSize in class ServletResponseWrapper

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

Overrides:

getBufferSize in class ServletResponseWrapper

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

Overrides:

isCommitted in class ServletResponseWrapper

reset

public void reset()

Specified by:

reset in interface ServletResponse

Overrides:

reset in class ServletResponseWrapper

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

Overrides:

resetBuffer in class ServletResponseWrapper

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface ServletResponse

Overrides:

setLocale in class ServletResponseWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

Overrides:

getLocale in class ServletResponseWrapper