org.opencms.configuration.I_CmsConfigurationParameterHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.configuration;

/**
 * Used for classes that are configurable using
 * <param name="name">value</param>
 * in the XML configuration.
 *
 * Such "param" nodes can be used to add some arbitrary names
 * parameters to classes that otherwise share the same XML configuration.
 *
 * @since 6.0.0
 */
public interface I_CmsConfigurationParameterHandler {

    /** The name of the addConfigurationParameter() method. */
    String ADD_PARAMETER_METHOD = "addConfigurationParameter";

    /** The name of the initConfiguration() method. */
    String INIT_CONFIGURATION_METHOD = "initConfiguration";

    /**
     * Adds a configuration parameter to this parameter configurable class instance.

     *
     * @param paramName the name of the parameter
     * @param paramValue the value for the parameter
     */
    void addConfigurationParameter(String paramName, String paramValue);

    /**
     * Returns the parameters of this configurable class instance,
     * or null if the class does not need any parameters.

     *
     * @return the parameters of this configurable class instance,
     *      or null if the class does not need any parameters
     */
    CmsParameterConfiguration getConfiguration();

    /**
     * Initializes a configuration after all parameters have been added.
     *
     * @throws CmsConfigurationException if something goes wrong
     */
    void initConfiguration() throws CmsConfigurationException;
}