Package org.ametys.web.repository.page.virtual

Class VirtualPageConfiguration

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.repository.page.virtual.VirtualPageConfiguration

All Implemented Interfaces:

LogEnabled, PluginAware, Initializable, Configurable, Contextualizable, Serviceable

public class VirtualPageConfiguration
extends AbstractLogEnabled
implements Configurable, Serviceable, Contextualizable, PluginAware, Initializable

This class represents the configuration of a virtual page based on an XML configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected Context	_context	The context
protected FileReloaderUtils	_fileReloaderUtils	The file reloader utils
protected SiteManager	_siteManager	The site manager

Constructor Summary

Constructors

Constructor	Description
VirtualPageConfiguration()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
void	contextualize(Context context)
String	getTemplate(Page rootPage)	Get the template's id
VirtualZoneConfiguration	getZoneConfiguration(String id, Page rootPage)	Get the zone configuration for a zone id
Collection<VirtualZoneConfiguration>	getZonesConfigurations(Page rootPage)	Get the zones configurations
boolean	hasZoneConfiguration(String id, Page rootPage)	Check if the virtual page has a zone, by its id
void	initialize()
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

Field Details

_fileReloaderUtils

protected FileReloaderUtils _fileReloaderUtils

The file reloader utils

_siteManager

protected SiteManager _siteManager

The site manager

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_context

protected Context _context

The context

Constructor Details

VirtualPageConfiguration

public VirtualPageConfiguration()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getTemplate

public String getTemplate(Page rootPage)

Get the template's id

Parameters:

rootPage - The root page

Returns:

The template's id

getZonesConfigurations

public Collection<VirtualZoneConfiguration> getZonesConfigurations(Page rootPage)

Get the zones configurations

Parameters:

rootPage - The root page

Returns:

The collection of VirtualPageZoneConfiguration

hasZoneConfiguration

public boolean hasZoneConfiguration(String id,
 Page rootPage)

Check if the virtual page has a zone, by its id

Parameters:

id - The zone id

rootPage - The root page

Returns:

true if the page has a zone of the id given, false otherwise

getZoneConfiguration

public VirtualZoneConfiguration getZoneConfiguration(String id,
 Page rootPage)

Get the zone configuration for a zone id

Parameters:

id - The zone id

rootPage - The root page

Returns:

The VirtualPageZoneConfiguration, null if none is found