Package org.ametys.web.cache

Class PageHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.cache.PageHelper

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class PageHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper component providing status of pages.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
PageHelper()

Method Summary

Modifier and Type	Method	Description
List<Content>	getAllContents(Page page)	Get all the contents inside a page
boolean	isCacheable(Page page)	Tests if a page is cacheable, i.e: its access is not restricted all its page elements are cacheable
boolean	isCaptchaRequired(SitemapElement page)	Determines if a captcha is required on forms of the page
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

Constructor Details

PageHelper

public PageHelper()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isCacheable

public boolean isCacheable(Page page)

Tests if a page is cacheable, i.e:

• its access is not restricted
• all its page elements are cacheable

Parameters:

page - The page to test.

Returns:

true if the page is cacheable, false otherwise.

isCaptchaRequired

public boolean isCaptchaRequired(SitemapElement page)

Determines if a captcha is required on forms of the page

Parameters:

page - The page to test

Returns:

true if a captcha is required

getAllContents

public List<Content> getAllContents(Page page)

Get all the contents inside a page

Parameters:

page - page to search

Returns:

list of contents in this page