001/*
002 *  Copyright 2023 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.analytics;
017
018import org.apache.avalon.framework.configuration.Configuration;
019import org.apache.avalon.framework.configuration.ConfigurationException;
020import org.apache.commons.codec.binary.StringUtils;
021
022import org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint;
023
024/**
025 * Extension point holding all {@link WebAnalyticsProvider} classes for needing features.
026 */
027public class WebAnalyticsProviderExtensionPoint extends AbstractThreadSafeComponentExtensionPoint<WebAnalyticsProvider>
028{
029    /** Avalon Role */
030    public static final String ROLE = WebAnalyticsProviderExtensionPoint.class.getName();
031    
032    /** Fake id provided by the config when no provider should be used */
033    public static final String NO_PROVIDER_ID = "none";
034    
035    @Override
036    public void addExtension(String id, String pluginName, String featureName, Configuration configuration) throws ConfigurationException
037    {
038        if (StringUtils.equals(id, NO_PROVIDER_ID))
039        {
040            throw new ConfigurationException("Can't add an extension with id '" + NO_PROVIDER_ID + "' to extension point of type '" + WebAnalyticsProviderExtensionPoint.class.getName() + "'. This id is reserved.", configuration);
041        }
042        super.addExtension(id, pluginName, featureName, configuration);
043    }
044}