org.hdiv.filter
Class ResponseWrapper

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.hdiv.filter.ResponseWrapper

All Implemented Interfaces:

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

public class ResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

A wrapper for HTTP servlet response.

Since:

HDIV 1.1

Author:

Gorka Vicente

See Also:

HttpServletResponseWrapper

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

ResponseWrapper(javax.servlet.http.HttpServletResponse originalResponse)
Constructs a response object wrapping the given response.

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie) Adds the specified cookie to the response.
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.
java.util.Hashtable	getCookies() Obtains all the cookies added by the application.
void	removeCookiesFromSession() Removes from user's session the cookies added by the application.
java.lang.String	replaceOriginalValues(java.util.List values, java.lang.String value) Replaces cookies' original values by relative values in order to provide confidentiality.
void	reset() Resets the response.
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.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

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

Constructor Detail

ResponseWrapper

public ResponseWrapper(javax.servlet.http.HttpServletResponse originalResponse)

Constructs a response object wrapping the given response.

Parameters:

originalResponse - response

Method Detail

setHeader

public 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.

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the header value

See Also:

HttpServletResponseWrapper.setHeader(java.lang.String, java.lang.String)

addHeader

public 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.

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the header value

See Also:

HttpServletResponseWrapper.addHeader(java.lang.String, java.lang.String)

replaceOriginalValues

public java.lang.String replaceOriginalValues(java.util.List values,
                                              java.lang.String value)

Replaces cookies' original values by relative values in order to provide confidentiality.

Parameters:

values - List of the original values to be replaced

value - Original value of the cookie to be added

Returns:

Confidential values for the cookies

reset

public void reset()

Resets the response.

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class javax.servlet.ServletResponseWrapper

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Adds the specified cookie to the response. It can be called multiple times to set more than one cookie.

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

The - Cookie to return to the client

See Also:

HttpServletResponse.addCookie(javax.servlet.http.Cookie)

removeCookiesFromSession

public void removeCookiesFromSession()

Removes from user's session the cookies added by the application.

getCookies

public java.util.Hashtable getCookies()

Obtains all the cookies added by the application.

Returns:

cookies added by the application