GenericResponseWrapper

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> cactus >> sample >> servlet >> [ util overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.cactus.sample.servlet.util.GenericResponseWrapper

SOURCE |

Download org.apache.cactus.sample.servlet.util.GenericResponseWrapper

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cactus.sample.servlet.util
Class GenericResponseWrapper

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.apache.cactus.sample.servlet.util.GenericResponseWrapper

All Implemented Interfaces:: javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class GenericResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

Wrapper around a HttpServletResponse that we use to easily write filters that manipulate the output stream. Indeed, we cannot pass the output stream of our filter direectly to the next filter in the chain because then we won't be able to write to it (the response will have been committed). Instead, we pass this wrapper class and then copy its data to our filter output stream. Note: This code was adapted from the Filter tutorial found here

Version:: $Id: GenericResponseWrapper.java,v 1.3 2004/02/29 16:36:45 vmassol Exp $

Field Summary

private int contentLength
          Save the content length so that we can query it at a later time (otherwise it would not be possible as HttpServletResponseWrapper does not have a method to get the content length).

private java.lang.String contentType
          Save the content type so that we can query it at a later time (otherwise it would not be possible as HttpServletResponseWrapper does not have a method to get the content type).

private java.io.ByteArrayOutputStream output
          Holder for the output data

Fields inherited from class javax.servlet.ServletResponseWrapper

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

GenericResponseWrapper(javax.servlet.http.HttpServletResponse theResponse)


Method Summary

int getContentLength()


java.lang.String getContentType()
          Returns the content type used for the MIME body sent in this response.

byte[] getData()


javax.servlet.ServletOutputStream getOutputStream()
          Returns a javax.servlet.ServletOutputStream suitable for writing binary data in the response.

java.io.PrintWriter getWriter()
          Returns a PrintWriter object that can send character text to the client.

void setContentLength(int theLength)
          Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

void setContentType(java.lang.String theType)
          Sets the content type of the response being sent to the client, if the response has not been committed yet.

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, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, 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, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setLocale

Field Detail

output

private java.io.ByteArrayOutputStream output

Holder for the output data

contentLength

private int contentLength

Save the content length so that we can query it at a later time (otherwise it would not be possible as HttpServletResponseWrapper does not have a method to get the content length).

contentType

private java.lang.String contentType

Save the content type so that we can query it at a later time (otherwise it would not be possible as HttpServletResponseWrapper does not have a method to get the content type).

Constructor Detail

GenericResponseWrapper

public GenericResponseWrapper(javax.servlet.http.HttpServletResponse theResponse)

Method Detail