org.ametys.web.filter

Class FilteredContentsService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.web.filter.FilteredContentsService

All Implemented Interfaces:

LogEnabled, PluginAware, Service, Disposable, Configurable, Contextualizable, Serviceable

public class FilteredContentsService
extends StaticService

Static service which cacheability depends on the "handle-user-access" parameter.
The service is not cacheable if contents are displayed depending on the connected user's rights.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.web.service.StaticService

StaticService.ServiceParameterOrRepeaterParser

Field Summary

Fields inherited from class org.ametys.web.service.StaticService

_context, _featureName, _groups, _manager, _parameters, _paramsScript, _pluginName

Constructor Summary

Constructors

Constructor and Description
FilteredContentsService()

Method Summary

Modifier and Type	Method and Description
boolean	isCacheable(Page currentPage, ZoneItem zoneItem) Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Methods inherited from class org.ametys.web.service.StaticService

_configureClass, _configureImports, _configureScript, _parseI18nizableText, configure, configureIndexation, configureParameterGroup, configureParameterGroup, configureParameters, contextualize, dispose, getCategory, getCSSFiles, getDescription, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getParameterGroups, getParameters, getParametersScript, getPluginName, getRight, getSmallIcon, getURL, index, isPrivate, service, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredContentsService

public FilteredContentsService()

Method Detail

isCacheable

public boolean isCacheable(Page currentPage,
                           ZoneItem zoneItem)

Description copied from interface: Service

Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Specified by:

isCacheable in interface Service

Overrides:

isCacheable in class StaticService

Parameters:

currentPage - the current Page containing the service.

zoneItem - the ZoneItem containing an instance of this service.
N.B: The ZoneItem can belong to a page that is not the current page, when it is inherited.

Returns:

true if the result of this service may be cached.