org.ametys.web.repository.page

Class ZoneItemManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.repository.page.ZoneItemManager

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ZoneItemManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Class containing callables to retrieve and configure service parameters

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	__SERVICE_PARAM_UNTOUCHED_BINARY Constant for untouched binary metadata.
private Context	_context
private CurrentUserProvider	_currentUserProvider
private ObservationManager	_observationManager
private AmetysObjectResolver	_resolver
private ServiceExtensionPoint	_serviceExtensionPoint
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ZoneItemManager()

Method Summary

Modifier and Type	Method and Description
private void	_getAndSaveParameter(ModelItem def, Map<String,Object> values, ModifiableModelAwareDataHolder dataHolder, String prefix, Map<String,List<I18nizableText>> allErrors)
private Map<String,DefinitionAndValue>	_getBrothersDefinitionAndValues(String prefix, Map<String,Object> values, ElementDefinition definition) Get the definition and value pairs of the given definition brothers.
private Map<Integer,Integer>	_getRepeaterPositionsMapping(Map<String,Object> values, String repeaterPath)
private List<Map<String,Object>>	_getRepeaters(Collection<ModelItem> items, ModelAwareDataHolder dataHolder, String prefix)
private Map<String,Object>	_getValues(Collection<ModelItem> items, ModelAwareDataHolder dataHolder, String prefix)
(package private) void	_setParameterValues(ModifiableModelAwareDataHolder serviceDataHolder, Service service, Map<String,Object> values, Map<String,List<I18nizableText>> allErrors)
private void	_setRequestAttribute(String serviceId, String pageId, String zoneItemId, String zoneName)
Map<String,Object>	addService(String pageId, String zoneName, String serviceId, Map<String,Object> parameterValues) Add the service to the given zone on given page
void	contextualize(Context context)
Map<String,Object>	editServiceParameterValues(String zoneItemId, String serviceId, Map<String,Object> parameterValues) Edit the parameter values of the given service
Map<String,Object>	getServiceParameterDefinitions(String serviceId, String pageId, String zoneItemId, String zoneName) Retrieves the parameter definitions of the given service
Map<String,Object>	getServiceParameterValues(String zoneItemId, String serviceId) Get the service parameter values
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

__SERVICE_PARAM_UNTOUCHED_BINARY

protected static final String __SERVICE_PARAM_UNTOUCHED_BINARY

Constant for untouched binary metadata.

See Also:

Constant Field Values

_serviceExtensionPoint

private ServiceExtensionPoint _serviceExtensionPoint

_resolver

private AmetysObjectResolver _resolver

_observationManager

private ObservationManager _observationManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_context

private Context _context

Constructor Detail

ZoneItemManager

public ZoneItemManager()

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

getServiceParameterDefinitions

public Map<String,Object> getServiceParameterDefinitions(String serviceId,
                                                         String pageId,
                                                         String zoneItemId,
                                                         String zoneName)
                                                  throws ProcessingException

Retrieves the parameter definitions of the given service

Parameters:

serviceId - Identifier of the service

pageId - the page id

zoneItemId - the zone item id

zoneName - the zone name

Returns:

the parameter definitions

Throws:

ProcessingException - if an error occurs

_setRequestAttribute

private void _setRequestAttribute(String serviceId,
                                  String pageId,
                                  String zoneItemId,
                                  String zoneName)

getServiceParameterValues

public Map<String,Object> getServiceParameterValues(String zoneItemId,
                                                    String serviceId)

Get the service parameter values

Parameters:

zoneItemId - the zone item id

serviceId - the service Id

Returns:

the values

_getValues

private Map<String,Object> _getValues(Collection<ModelItem> items,
                                      ModelAwareDataHolder dataHolder,
                                      String prefix)

_getRepeaters

private List<Map<String,Object>> _getRepeaters(Collection<ModelItem> items,
                                               ModelAwareDataHolder dataHolder,
                                               String prefix)

addService

public Map<String,Object> addService(String pageId,
                                     String zoneName,
                                     String serviceId,
                                     Map<String,Object> parameterValues)
                              throws IOException

Add the service to the given zone on given page

Parameters:

pageId - The page identifier

zoneName - The zone name

serviceId - The identifier of the service to add

parameterValues - the service parameter values. Can be empty

Returns:

The result with the identifiers of updated page, zone and zone item

Throws:

IOException - if an error occurred while saving parameters

editServiceParameterValues

public Map<String,Object> editServiceParameterValues(String zoneItemId,
                                                     String serviceId,
                                                     Map<String,Object> parameterValues)
                                              throws IOException

Edit the parameter values of the given service

Parameters:

zoneItemId - The identifier of the zone item holding the service

serviceId - The service identifier

parameterValues - the service parameter values to update

Returns:

The result with the identifiers of updated page, zone and zone item

Throws:

IOException - if an error occurs while saving parameters

_setParameterValues

void _setParameterValues(ModifiableModelAwareDataHolder serviceDataHolder,
                         Service service,
                         Map<String,Object> values,
                         Map<String,List<I18nizableText>> allErrors)

_getAndSaveParameter

private void _getAndSaveParameter(ModelItem def,
                                  Map<String,Object> values,
                                  ModifiableModelAwareDataHolder dataHolder,
                                  String prefix,
                                  Map<String,List<I18nizableText>> allErrors)

_getBrothersDefinitionAndValues

private Map<String,DefinitionAndValue> _getBrothersDefinitionAndValues(String prefix,
                                                                       Map<String,Object> values,
                                                                       ElementDefinition definition)

Get the definition and value pairs of the given definition brothers. The definition and value pairs are indexed by the parameter name

Parameters:

prefix - prefix to get the parameter values

values - all the parameter values

definition - the definition

Returns:

the definition and value pairs of the given definition brother

_getRepeaterPositionsMapping

private Map<Integer,Integer> _getRepeaterPositionsMapping(Map<String,Object> values,
                                                          String repeaterPath)