Module com.aoapps.servlet.subrequest

Package com.aoapps.servlet.subrequest

Class ServletSubResponse

java.lang.Object

com.aoapps.servlet.subrequest.ServletSubResponse

All Implemented Interfaces:

IServletSubResponse, ServletResponse

Direct Known Subclasses:

HttpServletSubResponse

public class ServletSubResponse
extends Object
implements IServletSubResponse

This does not implement ServletResponseWrapper and use of it is in violation of the specification. When used in conjunction with new threads (or threads from your own pool), Tomcat 7.0 and 8.5 do not notice you switched the response due to its use of ThreadLocal to enforce the spec. This is very hackish and fragile - use at your own risk.

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.

It is expected that the wrapped response will not change for the life of this wrapper. If it does change, the changes may or may not be visible depending on what has been accessed and changed on this response.

This class is not thread safe.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	committed

Constructor Summary

Constructors

Constructor	Description
ServletSubResponse(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 java.lang.Object

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

Field Details

committed

protected boolean committed

Constructor Details

ServletSubResponse

public ServletSubResponse(ServletResponse resp,
 TempFileContext tempFileContext)

Method Details

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

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

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface ServletResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse