I_CmsSetupXmlUpdate.java

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (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, 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.setup.xml;

import org.opencms.setup.CmsSetupBean;

/**
 * Represent a change to be applied to a xml file.<p>
 * 
 * @since 6.1.8 
 */
public interface I_CmsSetupXmlUpdate {

    /**
     * Execute the change.<p>
     * 
     * @param setupBean the setup bean
     * 
     * @throws Exception if something goes wrong 
     */
    void execute(CmsSetupBean setupBean) throws Exception;

    /**
     * Returns the code to be added OR removed in the xml file.<p>
     * 
     * @param setupBean the setup bean
     * 
     * @return the code to be changed
     * 
     * @throws Exception if something goes wrong 
     */
    String getCodeToChange(CmsSetupBean setupBean) throws Exception;

    /**
     * Returns the nice name for the change.<p>
     * 
     * @return the nice name
     */
    String getName();

    /**
     * Returns the affected xml configuration file name.<p>
     * 
     * @return the xml file name
     */
    String getXmlFilename();

    /**
     * Validates the need to apply this change.<p>
     * 
     * @param setupBean the setup bean
     * 
     * @return <code>true</code> if needed
     * 
     * @throws Exception if something goes wrong 
     */
    boolean validate(CmsSetupBean setupBean) throws Exception;
}