Package org.ametys.web.parameters.view

Class ServiceViewParametersManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.parameters.view.ServiceViewParametersManager

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Contextualizable, Serviceable

public class ServiceViewParametersManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Initializable, Disposable

Manager for service view parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceViewParametersManager.ServiceViewParametersReloader	Class representing a service view parameters reloader

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected FileReloaderUtils	_fileReloaderUtils	The file reloader utils
protected ServiceManager	_manager	The service manager
protected ServiceExtensionPoint	_serviceExtensionPoint	The service extension point
protected org.ametys.web.parameters.view.ServiceViewParametersManager.SkinsServiceViewParameters	_skinsServiceViewParameters	The object representing the view parameters of the different service by skin
protected ViewAndParametersParser	_viewAndParametersParser	The view and parameters parser
protected ViewParameterTypeExtensionPoint	_viewParametersEP	The view parameter type extension point
protected ViewParametersManager	_viewParametersManager	The view parameters manager
static String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ServiceViewParametersManager()

Method Summary

Modifier and Type	Method	Description
protected Optional<ViewParametersModel>	_configureViewParameters(Configuration paramConfiguration, String viewParametersId, String plugin, String catalog)	Parse service view parameters from the configuration
void	contextualize(Context context)
void	dispose()
Optional<ViewParametersModel>	getViewParameters(String skinId, String serviceId, String viewName)	Get the view parameters of a service
void	initialize()
void	service(ServiceManager manager)

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 Detail

ROLE

public static final String ROLE

Avalon Role

_fileReloaderUtils

protected FileReloaderUtils _fileReloaderUtils

The file reloader utils

_viewParametersEP

protected ViewParameterTypeExtensionPoint _viewParametersEP

The view parameter type extension point

_viewAndParametersParser

protected ViewAndParametersParser _viewAndParametersParser

The view and parameters parser

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The service extension point

_context

protected Context _context

The avalon context

_manager

protected ServiceManager _manager

The service manager

_skinsServiceViewParameters

protected org.ametys.web.parameters.view.ServiceViewParametersManager.SkinsServiceViewParameters _skinsServiceViewParameters

The object representing the view parameters of the different service by skin

_viewParametersManager

protected ViewParametersManager _viewParametersManager

The view parameters manager

Constructor Detail

ServiceViewParametersManager

public ServiceViewParametersManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getViewParameters

public Optional<ViewParametersModel> getViewParameters(String skinId,
                                                       String serviceId,
                                                       String viewName)

Get the view parameters of a service

Parameters:

skinId - the skin id

serviceId - the service id

viewName - the view name

Returns:

the view parameters

_configureViewParameters

protected Optional<ViewParametersModel> _configureViewParameters(Configuration paramConfiguration,
                                                                 String viewParametersId,
                                                                 String plugin,
                                                                 String catalog)
                                                          throws ConfigurationException

Parse service view parameters from the configuration

Parameters:

paramConfiguration - the configuration

viewParametersId - the view parameters id

plugin - the plugin

catalog - the catalog

Returns:

the view parameters

Throws:

ConfigurationException - if a configuration error occurred

dispose

public void dispose()

Specified by:

dispose in interface Disposable