Package org.ametys.web.repository.page

Class DefaultServicesAssignmentHandler

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.repository.page.DefaultServicesAssignmentHandler

All Implemented Interfaces:

ServicesAssignmentHandler, Initializable, LogEnabled, Serviceable

public class DefaultServicesAssignmentHandler
extends AbstractLogEnabled
implements ServicesAssignmentHandler, Serviceable, Initializable

This implementation of the services handler is based on services declared in the whole application

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DefaultServicesAssignmentHandler.ServiceCache	The cache is a HashSet of String + a date
protected static class	DefaultServicesAssignmentHandler.ViewCache	The cache is a HashMap of String + a date

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected ServiceExtensionPoint	_serviceEP	The services manager
protected SiteTypesExtensionPoint	_siteTypeExtensionPoint	The site type manager
protected SourceResolver	_srcResolver	The source resolver

Fields inherited from interface org.ametys.web.repository.page.ServicesAssignmentHandler

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultServicesAssignmentHandler()

Method Summary

Modifier and Type	Method	Description
protected DefaultServicesAssignmentHandler.ServiceCache	_getPublicServices()	Get the public services.
protected DefaultServicesAssignmentHandler.ServiceCache	_parseServices(Configuration configuration, long lastModificationDade)	Parses the valid services in a configuration.
protected DefaultServicesAssignmentHandler.ServiceCache	_parseServices(Source configFile)	Parses the valid services for the site type
protected DefaultServicesAssignmentHandler.ViewCache	_parseServicesViews(Configuration configuration, long lastModificationDade)	Parses the valid services in a configuration.
protected DefaultServicesAssignmentHandler.ViewCache	_parseServicesViews(Source configFile)	Parses the valid services views for the site type
protected DefaultServicesAssignmentHandler.ServiceCache	_parseTemplateServices(Source configFile)	Parse a template configuration file.
protected DefaultServicesAssignmentHandler.ViewCache	_parseTemplateServicesViews(Source configFile)	Parse a template configuration file.
protected DefaultServicesAssignmentHandler.ServiceCache	_parseZoneServices(Source configFile, String zoneName)	Parse a template configuration file and get the set of available services for a given zone.
protected DefaultServicesAssignmentHandler.ViewCache	_parseZoneServicesViews(Source configFile, String zoneName)	Parse a template configuration file and get the set of available services for a given zone.
Set<String>	getAvailableServices(SitemapElement page, String zoneName)	Returns the list of available services for a given Zone.
void	initialize()
Set<String>	limitAvailableServiceViews(Set<String> allViews, SitemapElement page, String zoneName, String serviceId)	Returns the list of authorized view for a given Page, zone name and service
void	service(ServiceManager manager)

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

_serviceEP

protected ServiceExtensionPoint _serviceEP

The services manager

_siteTypeExtensionPoint

protected SiteTypesExtensionPoint _siteTypeExtensionPoint

The site type manager

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

Constructor Details

DefaultServicesAssignmentHandler

public DefaultServicesAssignmentHandler()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getAvailableServices

public Set<String> getAvailableServices(SitemapElement page,
 String zoneName)

Description copied from interface: ServicesAssignmentHandler

Returns the list of available services for a given Zone.

Specified by:

getAvailableServices in interface ServicesAssignmentHandler

Parameters:

page - the Page to consider

zoneName - the zone name to consider

Returns:

the list of available services ' id for a given Page and Zone

limitAvailableServiceViews

public Set<String> limitAvailableServiceViews(Set<String> allViews,
 SitemapElement page,
 String zoneName,
 String serviceId)

Description copied from interface: ServicesAssignmentHandler

Returns the list of authorized view for a given Page, zone name and service

Specified by:

limitAvailableServiceViews in interface ServicesAssignmentHandler

Parameters:

allViews - All existing view to limit

page - The page to consider

zoneName - The zone name to consider

serviceId - The service to consider

Returns:

The non null list of available views

_getPublicServices

protected DefaultServicesAssignmentHandler.ServiceCache _getPublicServices()

Get the public services.

Returns:

the public services.

_parseTemplateServices

protected DefaultServicesAssignmentHandler.ServiceCache _parseTemplateServices(Source configFile)

Parse a template configuration file.

Parameters:

configFile - the template configuration file.

Returns:

the set of available services for the template.

_parseTemplateServicesViews

protected DefaultServicesAssignmentHandler.ViewCache _parseTemplateServicesViews(Source configFile)

Parse a template configuration file.

Parameters:

configFile - the template configuration file.

Returns:

the set of available services views for the template.

_parseZoneServices

protected DefaultServicesAssignmentHandler.ServiceCache _parseZoneServices(Source configFile,
 String zoneName)

Parse a template configuration file and get the set of available services for a given zone.

Parameters:

configFile - the template configuration file.

zoneName - the zone name.

Returns:

the set of available services for the given zone.

_parseZoneServicesViews

protected DefaultServicesAssignmentHandler.ViewCache _parseZoneServicesViews(Source configFile,
 String zoneName)

Parse a template configuration file and get the set of available services for a given zone.

Parameters:

configFile - the template configuration file.

zoneName - the zone name.

Returns:

the set of available services views for the given zone.

_parseServices

protected DefaultServicesAssignmentHandler.ServiceCache _parseServices(Source configFile)

Parses the valid services for the site type

Parameters:

configFile - the configuration file.

Returns:

the services id in a Set

_parseServicesViews

protected DefaultServicesAssignmentHandler.ViewCache _parseServicesViews(Source configFile)

Parses the valid services views for the site type

Parameters:

configFile - the configuration file.

Returns:

the services views id in a Set

_parseServices

protected DefaultServicesAssignmentHandler.ServiceCache _parseServices(Configuration configuration,
 long lastModificationDade)
                                                                throws ConfigurationException

Parses the valid services in a configuration.

Parameters:

configuration - the configuration.

lastModificationDade - last date of modification

Returns:

the services id in a Set

Throws:

ConfigurationException - if configuration is invalid

_parseServicesViews

protected DefaultServicesAssignmentHandler.ViewCache _parseServicesViews(Configuration configuration,
 long lastModificationDade)
                                                                  throws ConfigurationException

Parses the valid services in a configuration.

Parameters:

configuration - the configuration.

lastModificationDade - last date of modification

Returns:

the services id in a Set

Throws:

ConfigurationException - if configuration is invalid