| org.springframework.web.portlet.context.PortletApplicationObjectSupport org.springframework.web.portlet.handler.PortletContentGenerator
All known Subclasses: org.springframework.web.portlet.mvc.AbstractController,
Method Summary | |
final protected void | applyCacheSeconds(RenderResponse response, int seconds) | final protected void | cacheForSeconds(RenderResponse response, int seconds) Set portlet response to allow caching for the given number of seconds. | final protected void | check(PortletRequest request, PortletResponse response) Check and prepare the given request and response according to the settings
of this generator. | final protected void | checkAndPrepare(RenderRequest request, RenderResponse response) Check and prepare the given request and response according to the settings
of this generator. | final protected void | checkAndPrepare(RenderRequest request, RenderResponse response, int cacheSeconds) Check and prepare the given request and response according to the settings
of this generator. | final public int | getCacheSeconds() Return the number of seconds that content is cached. | final public boolean | isRequireSession() Return whether a session is required to handle requests. | final protected void | preventCaching(RenderResponse response) Prevent the render response from being cached. | final public void | setCacheSeconds(int seconds) Cache content for the given number of seconds. | final public void | setRequireSession(boolean requireSession) Set whether a session should be required to handle requests. |
applyCacheSeconds | final protected void applyCacheSeconds(RenderResponse response, int seconds)(Code) | | Apply the given cache seconds to the render response
Parameters: response - current portlet render response Parameters: seconds - positive number of seconds into the future that theresponse should be cacheable for, 0 to prevent caching |
cacheForSeconds | final protected void cacheForSeconds(RenderResponse response, int seconds)(Code) | | Set portlet response to allow caching for the given number of seconds.
Parameters: response - current portlet render response Parameters: seconds - number of seconds into the future that the responseshould be cacheable for |
check | final protected void check(PortletRequest request, PortletResponse response) throws PortletException(Code) | | Check and prepare the given request and response according to the settings
of this generator. Checks for a required session, and applies the number of
cache seconds configured for this generator (if it is a render request/response).
Parameters: request - current portlet request Parameters: response - current portlet response throws: PortletException - if the request cannot be handled because a check failed |
checkAndPrepare | final protected void checkAndPrepare(RenderRequest request, RenderResponse response) throws PortletException(Code) | | Check and prepare the given request and response according to the settings
of this generator. Checks for a required session, and applies the number of
cache seconds configured for this generator (if it is a render request/response).
Parameters: request - current portlet request Parameters: response - current portlet response throws: PortletException - if the request cannot be handled because a check failed |
checkAndPrepare | final protected void checkAndPrepare(RenderRequest request, RenderResponse response, int cacheSeconds) throws PortletException(Code) | | Check and prepare the given request and response according to the settings
of this generator. Checks for a required session, and applies the given
number of cache seconds (if it is a render request/response).
Parameters: request - current portlet request Parameters: response - current portlet response Parameters: cacheSeconds - positive number of seconds into the future that theresponse should be cacheable for, 0 to prevent caching throws: PortletException - if the request cannot be handled because a check failed |
getCacheSeconds | final public int getCacheSeconds()(Code) | | Return the number of seconds that content is cached.
|
isRequireSession | final public boolean isRequireSession()(Code) | | Return whether a session is required to handle requests.
|
preventCaching | final protected void preventCaching(RenderResponse response)(Code) | | Prevent the render response from being cached.
|
setCacheSeconds | final public void setCacheSeconds(int seconds)(Code) | | Cache content for the given number of seconds. Default is -1,
indicating no override of portlet content caching.
Only if this is set to 0 (no cache) or a positive value (cache for
this many seconds) will this class override the portlet settings.
The cache setting can be overwritten by subclasses, before content is generated.
|
setRequireSession | final public void setRequireSession(boolean requireSession)(Code) | | Set whether a session should be required to handle requests.
|
|
|