Package org.grails.web.sitemesh

Class GrailsPageResponseWrapper

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

org.grails.web.sitemesh.GrailsPageResponseWrapper

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse

public class GrailsPageResponseWrapper
extends jakarta.servlet.http.HttpServletResponseWrapper

Since:

1.0.4

Field Summary

Fields inherited from interface jakarta.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	Description
GrailsPageResponseWrapper(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, com.opensymphony.module.sitemesh.PageParserSelector parserSelector)

Method Summary

Modifier and Type	Method	Description
void	activateSiteMesh(String contentType, String encoding)
void	addHeader(String name, String value)	Prevent content-length being set if page is parseable.
protected void	applyContentType(String type)
protected void	clearBuffer()
void	deactivateSiteMesh()
void	flushBuffer()	Prevent buffer from being flushed if this is a page being parsed.
char[]	getContents()
jakarta.servlet.ServletOutputStream	getOutputStream()
com.opensymphony.module.sitemesh.Page	getPage()
PrintWriter	getWriter()
boolean	isGspSitemeshActive()
boolean	isSitemeshActive()
boolean	isUsingStream()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setContentLength(int contentLength)	Prevent content-length being set if page is parseable.
void	setContentType(String type)	Set the content-type of the request and store it so it can be passed to the PageParser.
void	setHeader(String name, String value)	Prevent content-length being set if page is parseable.
void	setStatus(int sc)	If 'not modified' (304) HTTP status is being sent - then abort parsing, as there shouldn't be any body

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, setDateHeader, setIntHeader, setTrailerFields

Methods inherited from class jakarta.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, 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 jakarta.servlet.ServletResponse

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

Constructor Details

GrailsPageResponseWrapper

public GrailsPageResponseWrapper(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 com.opensymphony.module.sitemesh.PageParserSelector parserSelector)

Method Details

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Overrides:

sendError in class jakarta.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Overrides:

sendError in class jakarta.servlet.http.HttpServletResponseWrapper

Throws:

IOException

setContentType

public void setContentType(String type)

Set the content-type of the request and store it so it can be passed to the PageParser.

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

Overrides:

setContentType in class jakarta.servlet.ServletResponseWrapper

applyContentType

protected void applyContentType(String type)

activateSiteMesh

public void activateSiteMesh(String contentType,
 String encoding)

deactivateSiteMesh

public void deactivateSiteMesh()

setContentLength

public void setContentLength(int contentLength)

Prevent content-length being set if page is parseable.

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

Overrides:

setContentLength in class jakarta.servlet.ServletResponseWrapper

flushBuffer

public void flushBuffer()
                 throws IOException

Prevent buffer from being flushed if this is a page being parsed.

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Overrides:

flushBuffer in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

setHeader

public void setHeader(String name,
 String value)

Prevent content-length being set if page is parseable.

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

Overrides:

setHeader in class jakarta.servlet.http.HttpServletResponseWrapper

addHeader

public void addHeader(String name,
 String value)

Prevent content-length being set if page is parseable.

Specified by:

addHeader in interface jakarta.servlet.http.HttpServletResponse

Overrides:

addHeader in class jakarta.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int sc)

If 'not modified' (304) HTTP status is being sent - then abort parsing, as there shouldn't be any body

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

Overrides:

setStatus in class jakarta.servlet.http.HttpServletResponseWrapper

clearBuffer

protected void clearBuffer()

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Overrides:

getOutputStream in class jakarta.servlet.ServletResponseWrapper

getWriter

public PrintWriter getWriter()

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Overrides:

getWriter in class jakarta.servlet.ServletResponseWrapper

getPage

public com.opensymphony.module.sitemesh.Page getPage()
                                              throws IOException

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class jakarta.servlet.http.HttpServletResponseWrapper

Throws:

IOException

isUsingStream

public boolean isUsingStream()

getContents

public char[] getContents()
                   throws IOException

Throws:

IOException

isSitemeshActive

public boolean isSitemeshActive()

isGspSitemeshActive

public boolean isGspSitemeshActive()