org.archive.wayback.webapp

Class PerfWritingHttpServletResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.archive.wayback.webapp.PerfWritingHttpServletResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class PerfWritingHttpServletResponse
extends javax.servlet.http.HttpServletResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected int	expireTimeout
protected boolean	hasWritten
protected javax.servlet.http.HttpServletResponse	httpResponse
protected PerfStats.OutputFormat	outputFormat
protected boolean	perfCookie
protected Enum<?>	perfStat
protected String	perfStatsHeader
protected String	requestURI

Fields inherited from interface javax.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

Constructor Summary

Constructors

Constructor and Description
PerfWritingHttpServletResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Enum<?> stat, String perfStatsHeader) Initialize with default output format.
PerfWritingHttpServletResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Enum<?> stat, String perfStatsHeader, PerfStats.OutputFormat format) Initialize with all parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	enablePerfCookie() Deprecated. 1.8.1, no replacement. this method has no effect.
javax.servlet.ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setPerfCookie(boolean perfCookie) Set to true if wb_total_perf cookie should be set in the response.
void	writePerfStats() Write performance metrics to HTTP header field and Cookie.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, 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 javax.servlet.ServletResponse

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

Field Detail

perfStat

protected final Enum<?> perfStat

perfStatsHeader

protected final String perfStatsHeader

hasWritten

protected boolean hasWritten

httpResponse

protected final javax.servlet.http.HttpServletResponse httpResponse

outputFormat

protected PerfStats.OutputFormat outputFormat

expireTimeout

protected int expireTimeout

requestURI

protected final String requestURI

perfCookie

protected boolean perfCookie

Constructor Detail

PerfWritingHttpServletResponse

public PerfWritingHttpServletResponse(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Enum<?> stat,
                              String perfStatsHeader)

Initialize with default output format.

Parameters:

request -

response -

stat -

perfStatsHeader -

PerfWritingHttpServletResponse

public PerfWritingHttpServletResponse(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Enum<?> stat,
                              String perfStatsHeader,
                              PerfStats.OutputFormat format)

Initialize with all parameters.

Parameters:

request - requestURI is used as cookie path

response - wrapped response

stat - names stat for total elapsed time.

perfStatsHeader - names HTTP header field for dumping all stats.

format - format of perfStatsHeader

Method Detail

writePerfStats

public void writePerfStats()

Write performance metrics to HTTP header field and Cookie. You don't need to call this method explicitly. It is called implicitly by calls to sendError(int), sendRedirect(String), getWriter() or getOutputStream(). 2014-11-17 Now it doesn't call timeEnd for perfStat. Be sure to call endNow() explicitly.

sendError

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

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IOException

enablePerfCookie

public void enablePerfCookie()

Deprecated. 1.8.1, no replacement. this method has no effect.

setPerfCookie

public void setPerfCookie(boolean perfCookie)

Set to true if wb_total_perf cookie should be set in the response. In general this is a bad idea because it'll defeat front-end caching. As such, this is off by default.

Parameters:

perfCookie - true for sending out the cookie