BufferedHttpServletResponse (Jetspeed-2 Portal Components 2.1.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.resource
Class BufferedHttpServletResponse

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.apache.jetspeed.resource.BufferedHttpServletResponse

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

public class BufferedHttpServletResponse
extends javax.servlet.http.HttpServletResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

BufferedHttpServletResponse fully captures all HttpServletResponse interactions to be flushed out later. This wrapper is specifically written to allow included servlets to set headers, cookies, encoding etc. which isn't allowed by the servlet specification on included responses.

Call flush(HttpServletResponse) after the include has returned to flush out the buffered data, headers and state.

Note: the only method not fully supported by this buffered version is getCharacterEncoding(). Setting characterEncoding through setContentType or setLocale on this class won't be reflected in the return value from getCharacterEncoding(), and calling getWriter() won't set it either although calling setLocale, setContentType or setCharacterEncoding (servlet api 2.4+) after that will be ignored. But, when this object is flused to a (real) response, the contentType, locale and/or characterEncoding recorded will be set on the target response then.

Version:: $Id: BufferedHttpServletResponse.java 544024 2007-06-04 00:59:09Z ate $
Author:: Ate Douma

Nested Class Summary
`private static class`	`BufferedHttpServletResponse.CharArrayWriterBuffer`

Field Summary
`private ByteArrayOutputStream`	`byteOutputBuffer`
`private String`	`characterEncoding`
`private BufferedHttpServletResponse.CharArrayWriterBuffer`	`charOutputBuffer`
`private boolean`	`closed`
`private boolean`	`committed`
`private int`	`contentLength`
`private String`	`contentType`
`private ArrayList`	`cookies`
`private int`	`errorCode`
`private String`	`errorMessage`
`private boolean`	`flushed`
`private boolean`	`hasError`
`private boolean`	`hasStatus`
`private HashMap`	`headers`
`private Locale`	`locale`
`private javax.servlet.ServletOutputStream`	`outputStream`
`private PrintWriter`	`printWriter`
`private String`	`redirectLocation`
`private int`	`statusCode`

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_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

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_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
`BufferedHttpServletResponse(javax.servlet.http.HttpServletResponse response)`

Method Summary
`void`	`addCookie(javax.servlet.http.Cookie cookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(String name, int value)`
`boolean`	`containsHeader(String name)`
`private void`	`failIfCommitted()`
`void`	`flush(javax.servlet.http.HttpServletResponse response)`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`private ArrayList`	`getHeaderList(String name, boolean create)`
`Locale`	`getLocale()`
`javax.servlet.ServletOutputStream`	`getOutputStream()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`sendError(int errorCode)`
`void`	`sendError(int errorCode, String errorMessage)`
`void`	`sendRedirect(String redirectLocation)`
`void`	`setBufferSize(int size)`
`void`	`setCharacterEncoding(String charset)`
`void`	`setContentLength(int len)`
`void`	`setContentType(String type)`
`void`	`setDateHeader(String name, long date)`
`void`	`setHeader(String name, String value)`
`void`	`setIntHeader(String name, int value)`
`void`	`setLocale(Locale locale)`
`void`	`setStatus(int statusCode)`
`void`	`setStatus(int statusCode, String message)`

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
`encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL`

Methods inherited from class javax.servlet.ServletResponseWrapper
`getResponse, setResponse`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

byteOutputBuffer

private ByteArrayOutputStream byteOutputBuffer

charOutputBuffer

private BufferedHttpServletResponse.CharArrayWriterBuffer charOutputBuffer

outputStream

private javax.servlet.ServletOutputStream outputStream

printWriter

private PrintWriter printWriter

headers

private HashMap headers

cookies

private ArrayList cookies

errorCode

private int errorCode

statusCode

private int statusCode

errorMessage

private String errorMessage

redirectLocation

private String redirectLocation

committed

private boolean committed

hasStatus

private boolean hasStatus

hasError

private boolean hasError

locale

private Locale locale

closed

private boolean closed

characterEncoding

private String characterEncoding

contentLength

private int contentLength

contentType

private String contentType

flushed

private boolean flushed

Constructor Detail