org.opencms.flex
Class CmsFlexResponse

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.opencms.flex.CmsFlexResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class CmsFlexResponse
extends HttpServletResponseWrapper

Wrapper class for a HttpServletResponse.

This class wrapps the standard HttpServletResponse so that it's output can be delivered to the CmsFlexCache.

Since:

6.0.0

Version:

$Revision: 1.41 $

Author:

Alexander Kandzior

Field Summary

static char	FLEX_CACHE_DELIMITER The cache delimiter char.
protected static org.apache.commons.logging.Log	LOG The log object for this class.
static String	SET_HEADER Static string to indicate a header is "set" in the header maps.

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

CmsFlexResponse(HttpServletResponse res, CmsFlexController controller)
Constructor for the CmsFlexResponse, this variation one is usually used to wrap responses for further include calls in OpenCms.

CmsFlexResponse(HttpServletResponse res, CmsFlexController controller, boolean streaming, boolean isTopElement)
Constructor for the CmsFlexResponse, this variation is usually used for the "top" response.

Method Summary

void	addCookie(Cookie cookie) Method overloaded from the standard HttpServletRequest API.
void	addDateHeader(String name, long date) Method overlodad from the standard HttpServletRequest API.
void	addHeader(String name, String value) Method overlodad from the standard HttpServletRequest API.
void	addIntHeader(String name, int value) Method overlodad from the standard HttpServletRequest API.
void	addToIncludeList(String target, Map parameterMap) Adds an inclusion target to the list of include results.
String	getEncoding() Returns the value of the encoding used for this response.
Map	getHeaders() Provides access to the header cache of the top wrapper.
ServletOutputStream	getOutputStream() Method overlodad from the standard HttpServletRequest API.
PrintWriter	getWriter() Method overlodad from the standard HttpServletRequest API.
byte[]	getWriterBytes() Returns the bytes that have been written on the current writers output stream.
boolean	isSuspended() This flag indicates if the response is suspended or not.
boolean	isTopElement() Returns true if this response has been constructed for the top level element of this request, false if it was constructed for an included sub-element.
static void	processHeaders(Map headers, HttpServletResponse res) Process the headers stored in the provided map and add them to the response.
void	sendRedirect(String location) Method overlodad from the standard HttpServletRequest API.
void	setContentType(String type) Method overlodad from the standard HttpServletRequest API.
void	setDateHeader(String name, long date) Method overlodad from the standard HttpServletRequest API.
void	setHeader(String name, String value) Method overlodad from the standard HttpServletRequest API.
void	setIntHeader(String name, int value) Method overlodad from the standard HttpServletRequest API.
void	setOnlyBuffering(boolean value) Sets buffering status of the response.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

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

Field Detail

FLEX_CACHE_DELIMITER

public static final char FLEX_CACHE_DELIMITER

The cache delimiter char.

See Also:

Constant Field Values

SET_HEADER

public static final String SET_HEADER

Static string to indicate a header is "set" in the header maps.

See Also:

Constant Field Values

LOG

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

The log object for this class.

Constructor Detail

CmsFlexResponse

public CmsFlexResponse(HttpServletResponse res,
                       CmsFlexController controller)

Constructor for the CmsFlexResponse, this variation one is usually used to wrap responses for further include calls in OpenCms.

Parameters:

res - the CmsFlexResponse to wrap

controller - the controller to use

CmsFlexResponse

public CmsFlexResponse(HttpServletResponse res,
                       CmsFlexController controller,
                       boolean streaming,
                       boolean isTopElement)

Constructor for the CmsFlexResponse, this variation is usually used for the "top" response.

Parameters:

res - the HttpServletResponse to wrap

controller - the controller to use

streaming - indicates if streaming should be enabled or not

isTopElement - indicates if this is the top element of an include cascade

Method Detail

processHeaders

public static void processHeaders(Map headers,
                                  HttpServletResponse res)

Process the headers stored in the provided map and add them to the response.

Parameters:

headers - the headers to add

res - the resonse to add the headers to

addCookie

public void addCookie(Cookie cookie)

Method overloaded from the standard HttpServletRequest API.

Cookies must be set directly as a header, otherwise they might not be set in the super class.

Specified by:

addCookie in interface HttpServletResponse

Overrides:

addCookie in class HttpServletResponseWrapper

See Also:

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

addDateHeader

public void addDateHeader(String name,
                          long date)

Method overlodad from the standard HttpServletRequest API.

Specified by:

addDateHeader in interface HttpServletResponse

Overrides:

addDateHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponse.addDateHeader(java.lang.String, long)

addHeader

public void addHeader(String name,
                      String value)

Method overlodad from the standard HttpServletRequest API.

Specified by:

addHeader in interface HttpServletResponse

Overrides:

addHeader in class HttpServletResponseWrapper

See Also:

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

addIntHeader

public void addIntHeader(String name,
                         int value)

Method overlodad from the standard HttpServletRequest API.

Specified by:

addIntHeader in interface HttpServletResponse

Overrides:

addIntHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponse.addIntHeader(java.lang.String, int)

addToIncludeList

public void addToIncludeList(String target,
                             Map parameterMap)

Adds an inclusion target to the list of include results.

Should be used only in inclusion-scenarios like the JSP cms:include tag processing.

Parameters:

target - the include target name to add

parameterMap - the map of parameters given with the include command

getEncoding

public String getEncoding()

Returns the value of the encoding used for this response.

Returns:

the value of the encoding used for this response

getHeaders

public Map getHeaders()

Provides access to the header cache of the top wrapper.

Returns:

the Map of cached headers

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Method overlodad from the standard HttpServletRequest API.

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

See Also:

ServletResponse.getOutputStream()

getWriter

public PrintWriter getWriter()
                      throws IOException

Method overlodad from the standard HttpServletRequest API.

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Throws:

IOException

See Also:

ServletResponse.getWriter()

getWriterBytes

public byte[] getWriterBytes()

Returns the bytes that have been written on the current writers output stream.

Returns:

the bytes that have been written on the current writers output stream

isSuspended

public boolean isSuspended()

This flag indicates if the response is suspended or not.

A suspended response mut not write further output to any stream or process a cache entry for itself.

Currently, a response is only suspended if it is redirected.

Returns:

true if the response is suspended, false otherwise

isTopElement

public boolean isTopElement()

Returns true if this response has been constructed for the top level element of this request, false if it was constructed for an included sub-element.

Returns:

true if this response has been constructed for the top level element of this request, false if it was constructed for an included sub-element.

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Method overlodad from the standard HttpServletRequest API.

Specified by:

sendRedirect in interface HttpServletResponse

Overrides:

sendRedirect in class HttpServletResponseWrapper

Throws:

IOException

See Also:

HttpServletResponse.sendRedirect(java.lang.String)

setContentType

public void setContentType(String type)

Method overlodad from the standard HttpServletRequest API.

Specified by:

setContentType in interface ServletResponse

Overrides:

setContentType in class ServletResponseWrapper

See Also:

ServletResponse.setContentType(java.lang.String)

setDateHeader

public void setDateHeader(String name,
                          long date)

Method overlodad from the standard HttpServletRequest API.

Specified by:

setDateHeader in interface HttpServletResponse

Overrides:

setDateHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
                      String value)

Method overlodad from the standard HttpServletRequest API.

Specified by:

setHeader in interface HttpServletResponse

Overrides:

setHeader in class HttpServletResponseWrapper

See Also:

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

setIntHeader

public void setIntHeader(String name,
                         int value)

Method overlodad from the standard HttpServletRequest API.

Specified by:

setIntHeader in interface HttpServletResponse

Overrides:

setIntHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponse.setIntHeader(java.lang.String, int)

setOnlyBuffering

public void setOnlyBuffering(boolean value)

Sets buffering status of the response.

This must be done before the first output is written. Buffering is needed to process elements that can not be written directly to the output stream because their sub - elements have to be processed seperatly. Which is so far true only for JSP pages.

If buffering is on, nothing is written to the output stream even if streaming for this resonse is enabled.

Parameters:

value - the value to set