grails.plugin.cache.web

Class GenericResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

grails.plugin.cache.web.GenericResponseWrapper

All Implemented Interfaces:

java.io.Serializable, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class GenericResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper
implements java.io.Serializable

Provides a wrapper for HttpServletResponseWrapper.

It is used to wrap the real Response so that we can modify it after that the target of the request has delivered its response.

It uses the Wrapper pattern. Based on net.sf.ehcache.constructs.web.GenericResponseWrapper.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	contentLength
protected java.lang.String	contentType
protected java.util.List<javax.servlet.http.Cookie>	cookies
protected boolean	disableFlushBuffer
protected java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	headersMap
static org.apache.commons.logging.Log	LOG
protected javax.servlet.ServletOutputStream	out
protected int	statusCode
protected java.io.PrintWriter	writer

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

Constructors

Constructor and Description
GenericResponseWrapper(javax.servlet.http.HttpServletResponse response, SerializableOutputStream outputStream) Creates a GenericResponseWrapper

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(java.lang.String name, long date)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.String name, int value)
void	flush() Flushes all the streams for this response.
void	flushBuffer()
java.util.Collection<Header<? extends java.io.Serializable>>	getAllHeaders()
int	getContentLength()
java.lang.String	getContentType()
java.util.Collection<javax.servlet.http.Cookie>	getCookies()
javax.servlet.ServletOutputStream	getOutputStream()
int	getStatus()
java.io.PrintWriter	getWriter()
boolean	isDisableFlushBuffer() Is the wrapped reponse's buffer flushing disabled?
void	reset()
void	sendError(int code) Send the error.
void	sendError(int code, java.lang.String string) Send the error.
void	sendRedirect(java.lang.String string) Send the redirect.
void	setContentLength(int length)
void	setContentType(java.lang.String type)
void	setDateHeader(java.lang.String name, long date)
void	setDisableFlushBuffer(boolean disable) Set if the wrapped reponse's buffer flushing should be disabled.
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setStatus(int code)
void	setStatus(int code, java.lang.String msg)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders

Methods inherited from class javax.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, resetBuffer, setBufferSize, setCharacterEncoding, setContentLengthLong, 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

getBufferSize, getCharacterEncoding, getLocale, isCommitted, resetBuffer, setBufferSize, setCharacterEncoding, setContentLengthLong, setLocale

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

statusCode

protected int statusCode

contentLength

protected int contentLength

contentType

protected java.lang.String contentType

headersMap

protected final java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> headersMap

cookies

protected final java.util.List<javax.servlet.http.Cookie> cookies

out

protected javax.servlet.ServletOutputStream out

writer

protected transient java.io.PrintWriter writer

disableFlushBuffer

protected boolean disableFlushBuffer

Constructor Detail

GenericResponseWrapper

public GenericResponseWrapper(javax.servlet.http.HttpServletResponse response,
                      SerializableOutputStream outputStream)

Creates a GenericResponseWrapper

Method Detail

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

setStatus

public void setStatus(int code)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

sendError

public void sendError(int code,
             java.lang.String string)
               throws java.io.IOException

Send the error. If the response is not ok, most of the logic is bypassed and the error is sent raw Also, the content is not cached.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

code - the status code

string - the error message

Throws:

java.io.IOException

sendError

public void sendError(int code)
               throws java.io.IOException

Send the error. If the response is not ok, most of the logic is bypassed and the error is sent raw Also, the content is not cached.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

code - the status code

Throws:

java.io.IOException

sendRedirect

public void sendRedirect(java.lang.String string)
                  throws java.io.IOException

Send the redirect. If the response is not ok, most of the logic is bypassed and the error is sent raw. Also, the content is not cached.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

string - the URL to redirect to

Throws:

java.io.IOException

setStatus

public void setStatus(int code,
             java.lang.String msg)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

getStatus

public int getStatus()

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

getStatus in class javax.servlet.http.HttpServletResponseWrapper

setContentLength

public void setContentLength(int length)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

getContentLength

public int getContentLength()

setContentType

public void setContentType(java.lang.String type)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

setHeader

public void setHeader(java.lang.String name,
             java.lang.String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

addDateHeader

public void addDateHeader(java.lang.String name,
                 long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

setDateHeader

public void setDateHeader(java.lang.String name,
                 long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

addIntHeader

public void addIntHeader(java.lang.String name,
                int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

setIntHeader

public void setIntHeader(java.lang.String name,
                int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

getAllHeaders

public java.util.Collection<Header<? extends java.io.Serializable>> getAllHeaders()

addCookie

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

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

getCookies

public java.util.Collection<javax.servlet.http.Cookie> getCookies()

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class javax.servlet.ServletResponseWrapper

flush

public void flush()
           throws java.io.IOException

Flushes all the streams for this response.

Throws:

java.io.IOException

isDisableFlushBuffer

public boolean isDisableFlushBuffer()

Is the wrapped reponse's buffer flushing disabled?

Returns:

true if the wrapped reponse's buffer flushing disabled

setDisableFlushBuffer

public void setDisableFlushBuffer(boolean disable)

Set if the wrapped reponse's buffer flushing should be disabled.

Parameters:

disable - true if the wrapped reponse's buffer flushing should be disabled