org.ametys.plugins.maps

Class MapServiceHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.maps.MapServiceHelper

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class MapServiceHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper gathering callable methods for the maps plugin.

Field Summary

Fields

Modifier and Type	Field and Description
private CurrentUserProvider	_currentUserProvider
private ObservationManager	_observationManager
private AmetysObjectResolver	_resolver
private ServiceExtensionPoint	_serviceExtensionPoint

Constructor Summary

Constructors

Constructor and Description
MapServiceHelper()

Method Summary

Modifier and Type	Method and Description
private void	_getAndSaveParameter(String prefix, ServiceParameter param, Map<String,Object> formValues, ModifiableCompositeMetadata metadataHolder, Map<String,Errors> allErrors)
private void	_setParameterValues(ModifiableCompositeMetadata serviceMetadata, Service service, Map<String,Object> values, Map<String,Errors> allErrors)
Map<String,Object>	configureService(String serviceId, String zoneItemId, Map<String,Object> parameters) Configure service
Map<String,Object>	getServiceParameters(String zoneItemId) Get values of service parameters
void	service(ServiceManager manager)
Map<String,Object>	setService(String pageId, String serviceId, String zoneName, Map<String,Object> parameters) Set service

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 Detail

_resolver

private AmetysObjectResolver _resolver

_serviceExtensionPoint

private ServiceExtensionPoint _serviceExtensionPoint

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_observationManager

private ObservationManager _observationManager

Constructor Detail

MapServiceHelper

public MapServiceHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getServiceParameters

public Map<String,Object> getServiceParameters(String zoneItemId)

Get values of service parameters

Parameters:

zoneItemId - The zone item id

Returns:

The service parameters

setService

public Map<String,Object> setService(String pageId,
                                     String serviceId,
                                     String zoneName,
                                     Map<String,Object> parameters)
                              throws IOException

Set service

Parameters:

pageId - The page id

serviceId - The service id

zoneName - The name of zone of add service into

parameters - the service parameters. Can be empty

Returns:

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

Throws:

IOException - if an error occurred while saving parameters

configureService

public Map<String,Object> configureService(String serviceId,
                                           String zoneItemId,
                                           Map<String,Object> parameters)
                                    throws IOException

Configure service

Parameters:

serviceId - The service id

zoneItemId - The id of aone item holding this service

parameters - the service parameters to update

Returns:

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

Throws:

IOException - if an error occurred while saving parameters

_setParameterValues

private void _setParameterValues(ModifiableCompositeMetadata serviceMetadata,
                                 Service service,
                                 Map<String,Object> values,
                                 Map<String,Errors> allErrors)

_getAndSaveParameter

private void _getAndSaveParameter(String prefix,
                                  ServiceParameter param,
                                  Map<String,Object> formValues,
                                  ModifiableCompositeMetadata metadataHolder,
                                  Map<String,Errors> allErrors)