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.core.group.directory;
017
018import java.util.Map;
019
020import org.apache.avalon.framework.configuration.Configuration;
021
022import org.ametys.runtime.i18n.I18nizableText;
023import org.ametys.runtime.parameter.Parameter;
024import org.ametys.runtime.parameter.ParameterHelper.ParameterType;
025
026/**
027 * Default implementation of {@link GroupDirectoryModel}
028 */
029public class DefaultGroupDirectoryModel implements GroupDirectoryModel
030{
031    private String _id;
032    private Class<GroupDirectory> _groupDirectoryClass;
033    private Configuration _groupDirectoryConfig;
034    private I18nizableText _label;
035    private I18nizableText _description;
036    private Map<String, ? extends Parameter<ParameterType>> _parameters;
037    private String _pluginName;
038    
039    /**
040     * Constructor
041     * @param id The unique identifier of this group directory model
042     * @param groupDirectoryClass The {@link GroupDirectory} class
043     * @param groupDirectoryConfig Additional configuration for {@link GroupDirectory} class. Can be empty.
044     * @param label The i18n label
045     * @param description The i18n description
046     * @param parameters the parameters
047     * @param pluginName the plugin's name of declaration (for debug purpose)
048     */
049    public DefaultGroupDirectoryModel (String id, Class<GroupDirectory> groupDirectoryClass, Configuration groupDirectoryConfig, I18nizableText label, I18nizableText description, Map<String, ? extends Parameter<ParameterType>> parameters, String pluginName)
050    {
051        _id = id;
052        _groupDirectoryClass = groupDirectoryClass;
053        _groupDirectoryConfig = groupDirectoryConfig;
054        _label = label;
055        _description = description;
056        _parameters = parameters;
057        _pluginName = pluginName;
058    }
059    
060    @Override
061    public String getId()
062    {
063        return _id;
064    }
065    
066    @Override
067    public I18nizableText getLabel()
068    {
069        return _label;
070    }
071    
072    @Override
073    public I18nizableText getDescription()
074    {
075        return _description;
076    }
077    
078    @Override
079    public Map<String, ? extends Parameter<ParameterType>> getParameters()
080    {
081        return _parameters;
082    }
083    
084    @Override
085    public String getPluginName()
086    {
087        return _pluginName;
088    }
089    
090    @Override
091    public Class<GroupDirectory> getGroupDirectoryClass()
092    {
093        return _groupDirectoryClass;
094    }
095    
096    @Override
097    public Configuration getGroupDirectoryConfiguration()
098    {
099        return _groupDirectoryConfig;
100    }
101}