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;
020
021import org.ametys.runtime.model.ElementDefinitionParser;
022import org.ametys.runtime.model.Enumerator;
023import org.ametys.runtime.parameter.Validator;
024import org.ametys.runtime.plugin.component.ThreadSafeComponentManager;
025
026/**
027 * This class parses the service parameter definition
028 */
029public class ServiceParameterDefinitionParser extends ElementDefinitionParser
030{
031    /**
032     * Creates a service parameter definition parser.
033     * @param serviceParameterTypeExtensionPoint the extension point to use to get available element types
034     * @param enumeratorManager the enumerator component manager.
035     * @param validatorManager the validator component manager.
036     */
037    public ServiceParameterDefinitionParser(ServiceParameterTypeExtensionPoint serviceParameterTypeExtensionPoint, ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager)
038    {
039        super(serviceParameterTypeExtensionPoint, enumeratorManager, validatorManager);
040    }
041    
042    @Override
043    protected ServiceParameter _createModelItem(Configuration definitionConfig) throws ConfigurationException
044    {
045        return new ServiceParameter<>();
046    }
047    
048    @Override
049    protected String _parseName(Configuration definitionConfig) throws ConfigurationException
050    {
051        String parameterName = super._parseName(definitionConfig);
052        
053        if (!parameterName.matches("^[a-zA-Z0-9_-]+$"))
054        {
055            throw new ConfigurationException("Invalid service parameter name: " + parameterName + ". The service parameter name must contain only letters, digits, underscore or dash characters.", definitionConfig);
056        }
057        
058        return parameterName;
059    }
060}