Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opencms >> flex >> [ cache overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.opencms.flex.cache
Class CmsFlexController  

java.lang.Object
  com.opencms.flex.cache.CmsFlexController

---

public class CmsFlexController

extends java.lang.Object

Controller for getting access to the CmsObject, should be used as a request attribute.

Version:

$Revision: 1.1.2.1 $

---

Field Summary
static java.lang.String	ATTRIBUTE_NAME           Constant for the controller request attribute name
private  CmsFlexCache	m_cache           The CmsFlexCache where the result will be cached in, required for the dispatcher
private  com.opencms.file.CmsObject	m_cmsObject           The wrapped CmsObject provides JSP with access to the core system
private  com.opencms.file.CmsFile	m_file           The CmsFile that was initialized by the original request, required for URI actions
private  java.util.List	m_flexRequestList           List of wrapped CmsFlexRequests
private  java.util.List	m_flexResponseList           List of wrapped CmsFlexResponses
private  javax.servlet.http.HttpServletRequest	m_req           Wrapped top request
private  javax.servlet.http.HttpServletResponse	m_res           Wrapped to response

 

Constructor Summary

CmsFlexController(com.opencms.file.CmsObject cms, com.opencms.file.CmsFile file, CmsFlexCache cache, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)           Default constructor.

 

Method Summary
CmsFlexCache	getCmsCache()           Returns the CmsFlexCache instance where all results from this request will be cached in.
com.opencms.file.CmsFile	getCmsFile()           This method provides access to the top-level CmsFile of the request which is of a type that supports the FlexCache, i.e.
com.opencms.file.CmsObject	getCmsObject()           Returns the wrapped CmsObject.
static com.opencms.file.CmsObject	getCmsObject(javax.servlet.ServletRequest req)           Returns the wrapped CmsObject form the provided request, or null if the request is not running inside OpenCms.
CmsFlexRequest	getCurrentRequest()
CmsFlexResponse	getCurrentResponse()
int	getResponseQueueSize()
javax.servlet.http.HttpServletRequest	getTopRequest()
javax.servlet.http.HttpServletResponse	getTopResponse()
static boolean	isCmsRequest(javax.servlet.ServletRequest req)           Checks if the provided request is running in OpenCms.
CmsFlexRequest	popRequest()
CmsFlexResponse	popResponse()
void	pushRequest(CmsFlexRequest req)
void	pushResponse(CmsFlexResponse res)
void	suspendFlexResponse()

 

Methods inherited from class java.lang.Object

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

 

Field Detail

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

Constant for the controller request attribute name

See Also:

Constant Field Values

---

m_cmsObject

private com.opencms.file.CmsObject m_cmsObject

The wrapped CmsObject provides JSP with access to the core system

---

m_cache

private CmsFlexCache m_cache

The CmsFlexCache where the result will be cached in, required for the dispatcher

---

m_file

private com.opencms.file.CmsFile m_file

The CmsFile that was initialized by the original request, required for URI actions

---

m_req

private javax.servlet.http.HttpServletRequest m_req

Wrapped top request

---

m_res

private javax.servlet.http.HttpServletResponse m_res

Wrapped to response

---

m_flexRequestList

private java.util.List m_flexRequestList

List of wrapped CmsFlexRequests

---

m_flexResponseList

private java.util.List m_flexResponseList

List of wrapped CmsFlexResponses

Constructor Detail

CmsFlexController

public CmsFlexController(com.opencms.file.CmsObject cms,
                         com.opencms.file.CmsFile file,
                         CmsFlexCache cache,
                         javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)

Default constructor.

Method Detail

getCmsObject

public com.opencms.file.CmsObject getCmsObject()

Returns the wrapped CmsObject.

---

getCmsObject

public static com.opencms.file.CmsObject getCmsObject(javax.servlet.ServletRequest req)

Returns the wrapped CmsObject form the provided request, or null if the request is not running inside OpenCms.

---

isCmsRequest

public static boolean isCmsRequest(javax.servlet.ServletRequest req)

Checks if the provided request is running in OpenCms.

---

getCmsCache

public CmsFlexCache getCmsCache()

Returns the CmsFlexCache instance where all results from this request will be cached in.

This is public so that pages like the Flex Cache Administration page have a way to access the cache object.

---

getCmsFile

public com.opencms.file.CmsFile getCmsFile()

This method provides access to the top-level CmsFile of the request which is of a type that supports the FlexCache, i.e. usually the CmsFile that is identical to the file uri requested by the user, not he current included element.

In case a JSP is used as a sub-element in a XMLTemplate, this method will not return the top-level uri but the "topmost" file of a type that is supported by the FlexCache. In case you need the top uri, use getCmsObject().getRequestContext().getUri().

---

getCurrentRequest

public CmsFlexRequest getCurrentRequest()

---

pushRequest

public void pushRequest(CmsFlexRequest req)

---

popRequest

public CmsFlexRequest popRequest()

---

getCurrentResponse

public CmsFlexResponse getCurrentResponse()

---

pushResponse

public void pushResponse(CmsFlexResponse res)

---

popResponse

public CmsFlexResponse popResponse()

---

suspendFlexResponse

public void suspendFlexResponse()

---

getResponseQueueSize

public int getResponseQueueSize()

---

getTopRequest

public javax.servlet.http.HttpServletRequest getTopRequest()

---

getTopResponse

public javax.servlet.http.HttpServletResponse getTopResponse()

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opencms >> flex >> [ cache overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---