001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.configuration;
029
030/**
031 * Used for classes that are configurable using
032 * <code>&lt;param name="name"&gt;value&lt;/param&gt;</code>
033 * in the XML configuration.<p>
034 *
035 * Such "param" nodes can be used to add some arbitrary names
036 * parameters to classes that otherwise share the same XML configuration.
037 *
038 * @since 6.0.0
039 */
040public interface I_CmsConfigurationParameterHandler {
041
042    /** The name of the addConfigurationParameter() method. */
043    String ADD_PARAMETER_METHOD = "addConfigurationParameter";
044
045    /** The name of the initConfiguration() method. */
046    String INIT_CONFIGURATION_METHOD = "initConfiguration";
047
048    /**
049     * Adds a configuration parameter to this parameter configurable class instance.<p>
050     *
051     * @param paramName the name of the parameter
052     * @param paramValue the value for the parameter
053     */
054    void addConfigurationParameter(String paramName, String paramValue);
055
056    /**
057     * Returns the parameters of this configurable class instance,
058     * or <code>null</code> if the class does not need any parameters.<p>
059     *
060     * @return the parameters of this configurable class instance,
061     *      or <code>null</code> if the class does not need any parameters
062     */
063    CmsParameterConfiguration getConfiguration();
064
065    /**
066     * Initializes a configuration after all parameters have been added.<p>
067     *
068     * @throws CmsConfigurationException if something goes wrong
069     */
070    void initConfiguration() throws CmsConfigurationException;
071}