Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.stats
Class BytesSentFilter.MonitoredResponse

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
          extended by com.jivesoftware.base.stats.BytesSentFilter.MonitoredResponse
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
Enclosing class:
BytesSentFilter

public class BytesSentFilter.MonitoredResponse
extends javax.servlet.http.HttpServletResponseWrapper

A wrapper class to a HttpServletResponse which monitors the amount of bytes transferred.


Field Summary
 
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
BytesSentFilter.MonitoredResponse(javax.servlet.http.HttpServletResponse response)
          Creates a new wrapped response object.
 
Method Summary
 long getBytesSent()
          Returns the total number of bytes sent.
 javax.servlet.ServletOutputStream getOutputStream()
          Overrides the ServletOutputStream used in this response object.
 java.io.PrintWriter getWriter()
          Overrides the PrintWriter used in this response object.
 
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, 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
 

Constructor Detail

BytesSentFilter.MonitoredResponse

public BytesSentFilter.MonitoredResponse(javax.servlet.http.HttpServletResponse response)
Creates a new wrapped response object.

Parameters:
response - the HTTP response.
Method Detail

getBytesSent

public long getBytesSent()
Returns the total number of bytes sent. If this can not be determined -1 is returned.

Returns:
the total number of bytes sent or -1 if it is unknown.

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException
Overrides the PrintWriter used in this response object. A BytesSentFilter.MonitoredPrintWriter instance is returned - we can measure the bytes sent using this class.

Specified by:
getWriter in interface javax.servlet.ServletResponse
Overrides:
getWriter in class javax.servlet.ServletResponseWrapper
Returns:
a BytesSentFilter.MonitoredPrintWriter instance.
Throws:
java.io.IOException - if an error occurs when creating the wrapped writer.

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException
Overrides the ServletOutputStream used in this response object. A BytesSentFilter.MonitoredServletOutputStream instance is returned - we can measure the bytes sent using this class.

Specified by:
getOutputStream in interface javax.servlet.ServletResponse
Overrides:
getOutputStream in class javax.servlet.ServletResponseWrapper
Returns:
a BytesSentFilter.MonitoredServletOutputStream instance.
Throws:
java.io.IOException - if an error occurs when creating the wrapped writer.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.