001/*
002 *  Copyright 2018 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.service;
017
018import org.apache.avalon.framework.configuration.Configuration;
019import org.apache.avalon.framework.configuration.ConfigurationException;
020import org.apache.avalon.framework.service.ServiceManager;
021
022import org.ametys.runtime.model.ElementDefinitionParser;
023import org.ametys.runtime.model.Enumerator;
024import org.ametys.runtime.model.Model;
025import org.ametys.runtime.model.ModelItemGroup;
026import org.ametys.runtime.parameter.Validator;
027import org.ametys.runtime.plugin.component.ThreadSafeComponentManager;
028
029/**
030 * This class parses the service parameter definition
031 */
032public class ServiceParameterDefinitionParser extends ElementDefinitionParser
033{
034    /**
035     * Creates a service parameter definition parser.
036     * @param serviceParameterTypeExtensionPoint the extension point to use to get available element types
037     * @param enumeratorManager the enumerator component manager.
038     * @param validatorManager the validator component manager.
039     */
040    public ServiceParameterDefinitionParser(ServiceParameterTypeExtensionPoint serviceParameterTypeExtensionPoint, ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager)
041    {
042        super(serviceParameterTypeExtensionPoint, enumeratorManager, validatorManager);
043    }
044    
045    @Override
046    public ServiceParameter parse(ServiceManager serviceManager, String pluginName, Configuration definitionConfig, Model model, ModelItemGroup parent) throws ConfigurationException
047    {
048        return (ServiceParameter) super.parse(serviceManager, pluginName, definitionConfig, model, parent);
049    }
050
051    @Override
052    protected ServiceParameter _createModelItem(Configuration definitionConfig) throws ConfigurationException
053    {
054        return new ServiceParameter<>();
055    }
056    
057    @Override
058    protected String _parseName(Configuration definitionConfig) throws ConfigurationException
059    {
060        String parameterName = super._parseName(definitionConfig);
061        
062        if (!parameterName.matches("^[a-zA-Z0-9_-]+$"))
063        {
064            throw new ConfigurationException("Invalid service parameter name: " + parameterName + ". The service parameter name must contain only letters, digits, underscore or dash characters.", definitionConfig);
065        }
066        
067        return parameterName;
068    }
069}