org.opencms.flex

类 CmsFlexResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.opencms.flex.CmsFlexResponse

所有已实现的接口:

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

public class CmsFlexResponse
extends javax.servlet.http.HttpServletResponseWrapper

Wrapper class for a HttpServletResponse, required in order to process JSPs from the OpenCms VFS.

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

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static char	FLEX_CACHE_DELIMITER The cache delimiter char.
protected static org.apache.commons.logging.Log	LOG The log object for this class.
static java.lang.String	SET_HEADER Static string to indicate a header is "set" in the header maps.

从接口继承的字段 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

构造器概要

构造器

构造器和说明
CmsFlexResponse(javax.servlet.http.HttpServletResponse res, CmsFlexController controller) Constructor for the CmsFlexResponse, this variation one is usually used to wrap responses for further include calls in OpenCms.
CmsFlexResponse(javax.servlet.http.HttpServletResponse res, CmsFlexController controller, boolean streaming, boolean isTopElement) Constructor for the CmsFlexResponse, this variation is usually used for the "top" response.

方法概要

方法

限定符和类型	方法和说明
void	addCookie(javax.servlet.http.Cookie cookie) Method overloaded from the standard HttpServletRequest API.
void	addDateHeader(java.lang.String name, long date) Method overload from the standard HttpServletRequest API.
void	addHeader(java.lang.String name, java.lang.String value) Method overload from the standard HttpServletRequest API.
void	addIntHeader(java.lang.String name, int value) Method overload from the standard HttpServletRequest API.
void	addToIncludeList(java.lang.String target, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Map<java.lang.String,java.lang.Object> attributeMap) Adds an inclusion target to the list of include results.
void	flushBuffer()
java.lang.String	getEncoding() Returns the value of the encoding used for this response.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Provides access to the header cache of the top wrapper.
javax.servlet.ServletOutputStream	getOutputStream() Method overload from the standard HttpServletRequest API.
java.io.PrintWriter	getWriter() Method overload 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(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers, javax.servlet.http.HttpServletResponse res) Process the headers stored in the provided map and add them to the response.
void	sendRedirect(java.lang.String location) Method overload from the standard HttpServletRequest API.
void	setContentType(java.lang.String type) Method overload from the standard HttpServletRequest API.
void	setDateHeader(java.lang.String name, long date) Method overload from the standard HttpServletRequest API.
void	setHeader(java.lang.String name, java.lang.String value) Method overload from the standard HttpServletRequest API.
void	setIntHeader(java.lang.String name, int value) Method overload from the standard HttpServletRequest API.
void	setOnlyBuffering(boolean value) Sets buffering status of the response.

从类继承的方法 javax.servlet.http.HttpServletResponseWrapper

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

从类继承的方法 javax.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setLocale, setResponse

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 javax.servlet.ServletResponse

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

字段详细资料

FLEX_CACHE_DELIMITER

public static final char FLEX_CACHE_DELIMITER

The cache delimiter char.

另请参阅:

常量字段值

SET_HEADER

public static final java.lang.String SET_HEADER

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

另请参阅:

常量字段值

LOG

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

The log object for this class.

构造器详细资料

CmsFlexResponse

public CmsFlexResponse(javax.servlet.http.HttpServletResponse res,
               CmsFlexController controller)

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

参数:

res - the CmsFlexResponse to wrap

controller - the controller to use

CmsFlexResponse

public CmsFlexResponse(javax.servlet.http.HttpServletResponse res,
               CmsFlexController controller,
               boolean streaming,
               boolean isTopElement)

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

参数:

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

方法详细资料

processHeaders

public static void processHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers,
                  javax.servlet.http.HttpServletResponse res)

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

参数:

headers - the headers to add

res - the response to add the headers to

addCookie

public void addCookie(javax.servlet.http.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.

指定者:

addCookie 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

addCookie 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

addDateHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

addDateHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

addDateHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

addHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

addHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

addHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

addIntHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

addIntHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

addIntHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

addToIncludeList

public void addToIncludeList(java.lang.String target,
                    java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                    java.util.Map<java.lang.String,java.lang.Object> attributeMap)

Adds an inclusion target to the list of include results.

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

参数:

target - the include target name to add

parameterMap - the map of parameters given with the include command

attributeMap - the map of attributes given with the include command

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

指定者:

flushBuffer 在接口中 javax.servlet.ServletResponse

覆盖:

flushBuffer 在类中 javax.servlet.ServletResponseWrapper

抛出:

java.io.IOException

另请参阅:

ServletResponseWrapper.flushBuffer()

getEncoding

public java.lang.String getEncoding()

Returns the value of the encoding used for this response.

返回:

the value of the encoding used for this response

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Provides access to the header cache of the top wrapper.

返回:

the Map of cached headers

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Method overload from the standard HttpServletRequest API.

指定者:

getOutputStream 在接口中 javax.servlet.ServletResponse

覆盖:

getOutputStream 在类中 javax.servlet.ServletResponseWrapper

抛出:

java.io.IOException

另请参阅:

ServletResponse.getOutputStream()

getWriter

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

Method overload from the standard HttpServletRequest API.

指定者:

getWriter 在接口中 javax.servlet.ServletResponse

覆盖:

getWriter 在类中 javax.servlet.ServletResponseWrapper

抛出:

java.io.IOException

另请参阅:

ServletResponse.getWriter()

getWriterBytes

public byte[] getWriterBytes()

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

返回:

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 must not write further output to any stream or process a cache entry for itself.

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

返回:

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.

返回:

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(java.lang.String location)
                  throws java.io.IOException

Method overload from the standard HttpServletRequest API.

指定者:

sendRedirect 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

sendRedirect 在类中 javax.servlet.http.HttpServletResponseWrapper

抛出:

java.lang.IllegalArgumentException - In case of a malformed location string

java.io.IOException

另请参阅:

HttpServletResponse.sendRedirect(java.lang.String)

setContentType

public void setContentType(java.lang.String type)

Method overload from the standard HttpServletRequest API.

指定者:

setContentType 在接口中 javax.servlet.ServletResponse

覆盖:

setContentType 在类中 javax.servlet.ServletResponseWrapper

另请参阅:

ServletResponse.setContentType(java.lang.String)

setDateHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

setDateHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

setDateHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

setHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

setHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

setHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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

setIntHeader

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

Method overload from the standard HttpServletRequest API.

指定者:

setIntHeader 在接口中 javax.servlet.http.HttpServletResponse

覆盖:

setIntHeader 在类中 javax.servlet.http.HttpServletResponseWrapper

另请参阅:

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 separately. 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 response is enabled.

参数:

value - the value to set