001/*
002 *  Copyright 2016 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.plugins.contentio.synchronize.impl;
017
018import java.util.Collection;
019import java.util.LinkedHashMap;
020import java.util.Map;
021
022import org.apache.avalon.framework.activity.Disposable;
023import org.apache.avalon.framework.configuration.Configurable;
024import org.apache.avalon.framework.configuration.Configuration;
025import org.apache.avalon.framework.configuration.ConfigurationException;
026import org.apache.avalon.framework.context.Context;
027import org.apache.avalon.framework.context.ContextException;
028import org.apache.avalon.framework.context.Contextualizable;
029import org.apache.avalon.framework.service.ServiceException;
030import org.apache.avalon.framework.service.ServiceManager;
031import org.apache.avalon.framework.service.Serviceable;
032
033import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection;
034import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionModel;
035import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionModelParameterParser;
036import org.ametys.runtime.i18n.I18nizableText;
037import org.ametys.runtime.model.Enumerator;
038import org.ametys.runtime.model.ModelItem;
039import org.ametys.runtime.model.disableconditions.DisableConditions;
040import org.ametys.runtime.model.type.ModelItemTypeExtensionPoint;
041import org.ametys.runtime.parameter.Validator;
042import org.ametys.runtime.plugin.component.AbstractLogEnabled;
043import org.ametys.runtime.plugin.component.PluginAware;
044import org.ametys.runtime.plugin.component.ThreadSafeComponentManager;
045
046/**
047 * Implementation of {@link SynchronizableContentsCollectionModel} able to populate contents from a LDAP source
048 *
049 */
050public class DefaultSynchronizableContentsCollectionModel extends AbstractLogEnabled implements SynchronizableContentsCollectionModel, Serviceable, Contextualizable, PluginAware, Configurable, Disposable
051{
052    private ModelItemTypeExtensionPoint _sccParameterTypeExtensionPoint;
053    private ServiceManager _manager;
054    private Context _context;
055    
056    // ComponentManager for disable conditions
057    private ThreadSafeComponentManager<DisableConditions> _disableConditionsManager;
058    
059    // ComponentManager for validators
060    private ThreadSafeComponentManager<Validator> _validatorManager;
061    
062    // ComponentManager for enumerators
063    private ThreadSafeComponentManager<Enumerator> _enumeratorManager;
064    
065    private String _id;
066    private Class<SynchronizableContentsCollection> _syncCollectionClass;
067    private I18nizableText _label;
068    private I18nizableText _description;
069    private int _priority;
070    private Map<String, ModelItem> _parameters = new LinkedHashMap<>();
071    private String _pluginName;
072    
073    public void service(ServiceManager manager) throws ServiceException
074    {
075        _manager = manager;
076        _sccParameterTypeExtensionPoint = (ModelItemTypeExtensionPoint) manager.lookup(ModelItemTypeExtensionPoint.ROLE_CONFIG);
077    }
078    
079    public void contextualize(Context context) throws ContextException
080    {
081        _context = context;
082    }
083    
084    public void setPluginInfo(String pluginName, String featureName, String id)
085    {
086        _pluginName = pluginName;
087        _id = id;
088    }
089    
090    @SuppressWarnings("unchecked")
091    public void configure(Configuration configuration) throws ConfigurationException
092    {
093        _label = I18nizableText.parseI18nizableText(configuration.getChild("label"), "plugin." + _pluginName);
094        _description = I18nizableText.parseI18nizableText(configuration.getChild("description"), "plugin." + _pluginName);
095        _priority = configuration.getChild("priority").getValueAsInteger(10000);
096        
097        String className = null;
098        try
099        {
100            className = configuration.getChild("class").getAttribute("name");
101            _syncCollectionClass = (Class<SynchronizableContentsCollection>) Class.forName(className);
102        }
103        catch (ClassNotFoundException | ConfigurationException e)
104        {
105            throw new ConfigurationException("SynchronizableContentsCollection model with id '" + _id + "' has an invalid configuration for class name " + (className != null ? className + " <class not found>" : "<missing tag <class>") + "'", e);
106        }
107        
108        if (!SynchronizableContentsCollection.class.isAssignableFrom(_syncCollectionClass))
109        {
110            throw new ConfigurationException("SynchronizableContentsCollection model with id '" + _id + "' has an invalid configuration: '" + className + "' is not an instance of SynchronizableContentsCollection");
111        }
112        
113        configureParameters(configuration);
114    }
115    
116    /**
117     * Configure the SCC parameters
118     * @param configuration the model configuration
119     * @throws ConfigurationException if a configuration exception occurred
120     */
121    protected void configureParameters(Configuration configuration) throws ConfigurationException
122    {
123        _disableConditionsManager = new ThreadSafeComponentManager<>();
124        _disableConditionsManager.setLogger(getLogger());
125        _disableConditionsManager.contextualize(_context);
126        _disableConditionsManager.service(_manager);
127        
128        _validatorManager = new ThreadSafeComponentManager<>();
129        _validatorManager.setLogger(getLogger());
130        _validatorManager.contextualize(_context);
131        _validatorManager.service(_manager);
132        
133        _enumeratorManager = new ThreadSafeComponentManager<>();
134        _enumeratorManager.setLogger(getLogger());
135        _enumeratorManager.contextualize(_context);
136        _enumeratorManager.service(_manager);
137        
138        SynchronizableContentsCollectionModelParameterParser sccParametersParser = new SynchronizableContentsCollectionModelParameterParser(_sccParameterTypeExtensionPoint, _disableConditionsManager, _enumeratorManager, _validatorManager);
139        
140        Configuration parametersConfiguration = configuration.getChild("parameters");
141        Configuration[] paramsConfiguration = parametersConfiguration.getChildren("param");
142        for (Configuration paramConfiguration : paramsConfiguration)
143        {
144            ModelItem parameter = sccParametersParser.parse(_manager, _pluginName, "plugin." + _pluginName, paramConfiguration, this, null);
145            String parameterPath = parameter.getPath();
146            
147            if (_parameters.containsKey(parameterPath))
148            {
149                throw new ConfigurationException("The parameter '" + parameterPath + "' is already declared. IDs must be unique.", paramConfiguration);
150            }
151            
152            _parameters.put(parameterPath, parameter);
153        }
154        
155        try
156        {
157            sccParametersParser.lookupComponents();
158        }
159        catch (Exception e)
160        {
161            throw new ConfigurationException("Unable to lookup parameter local components", configuration, e);
162        }
163    }
164    
165    public void dispose()
166    {
167        _disableConditionsManager.dispose();
168        _disableConditionsManager = null;
169        
170        _validatorManager.dispose();
171        _validatorManager = null;
172        
173        _enumeratorManager.dispose();
174        _enumeratorManager = null;
175    }
176    
177    public String getId()
178    {
179        return _id;
180    }
181
182    public I18nizableText getLabel()
183    {
184        return _label;
185    }
186
187    public I18nizableText getDescription()
188    {
189        return _description;
190    }
191    
192    public int getPriority()
193    {
194        return _priority;
195    }
196
197    public Collection<ModelItem> getModelItems()
198    {
199        return _parameters.values();
200    }
201    
202    public String getPluginName()
203    {
204        return _pluginName;
205    }
206
207    public Class<SynchronizableContentsCollection> getSynchronizableCollectionClass()
208    {
209        return _syncCollectionClass;
210    }
211}