Java 2 Platform EE v1.3: Class HttpServletResponseWrapper - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.servlet.http
Class HttpServletResponseWrapper

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
        |
        +--javax.servlet.http.HttpServletResponseWrapper

All Implemented Interfaces:: HttpServletResponse, ServletResponse

public class HttpServletResponseWrapper
extends ServletResponseWrapper
implements HttpServletResponse

Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.

Since:: v 2.3
See Also:: HttpServletResponse

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

HttpServletResponseWrapper(HttpServletResponse response)
          Constructs a response adaptor wrapping the given response.

Method Summary

void addCookie(Cookie cookie)
          The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.

void addDateHeader(java.lang.String name, long date)
          The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.

void addHeader(java.lang.String name, java.lang.String value)
          The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.

void addIntHeader(java.lang.String name, int value)
          The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.

boolean containsHeader(java.lang.String name)
          The default behavior of this method is to call containsHeader(String name) on the wrapped response object.

java.lang.String encodeRedirectUrl(java.lang.String url)
          The default behavior of this method is to return encodeRedirectUrl(String url) on the wrapped response object.

java.lang.String encodeRedirectURL(java.lang.String url)
          The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.

java.lang.String encodeUrl(java.lang.String url)
          The default behavior of this method is to call encodeUrl(String url) on the wrapped response object.

java.lang.String encodeURL(java.lang.String url)
          The default behavior of this method is to call encodeURL(String url) on the wrapped response object.

void sendError(int sc)
          The default behavior of this method is to call sendError(int sc) on the wrapped response object.

void sendError(int sc, java.lang.String msg)
          The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.

void sendRedirect(java.lang.String location)
          The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.

void setDateHeader(java.lang.String name, long date)
          The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.

void setHeader(java.lang.String name, java.lang.String value)
          The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.

void setIntHeader(java.lang.String name, int value)
          The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.

void setStatus(int sc)
          The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

void setStatus(int sc, java.lang.String sm)
          The default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object.

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, 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, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale

Constructor Detail

HttpServletResponseWrapper

public HttpServletResponseWrapper(HttpServletResponse response)

Constructs a response adaptor wrapping the given response.

Throws:: java.lang.IllegalArgumentException - if the response is null

Method Detail

addCookie

public void addCookie(Cookie cookie)

The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.

Specified by:: addCookie in interface HttpServletResponse