org.opencms.setup.xml.v7.CmsXmlAddImmutables Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* 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.setup.xml.v7;
import org.opencms.configuration.CmsConfigurationManager;
import org.opencms.configuration.CmsImportExportConfiguration;
import org.opencms.configuration.I_CmsXmlConfiguration;
import org.opencms.setup.xml.A_CmsSetupXmlUpdate;
import org.opencms.setup.xml.CmsSetupXmlHelper;
import java.util.ArrayList;
import java.util.List;
import org.dom4j.Document;
import org.dom4j.Node;
/**
* Adds the new immutable resources, from 6.2.3 to 7.0.x.
*
* @since 6.9.2
*/
public class CmsXmlAddImmutables extends A_CmsSetupXmlUpdate {
/** List of xpaths to update. */
private List m_xpaths;
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getName()
*/
public String getName() {
return "Add new immutable resources";
}
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getXmlFilename()
*/
public String getXmlFilename() {
return CmsImportExportConfiguration.DEFAULT_XML_FILE_NAME;
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#executeUpdate(org.dom4j.Document, java.lang.String, boolean)
*/
@Override
protected boolean executeUpdate(Document document, String xpath, boolean forReal) {
Node node = document.selectSingleNode(xpath);
if (node == null) {
if (xpath.equals(getXPathsToUpdate().get(0))) {
CmsSetupXmlHelper.setValue(document, xpath + "/@" + I_CmsXmlConfiguration.A_URI, "/system/categories/");
}
return true;
}
return false;
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getCommonPath()
*/
@Override
protected String getCommonPath() {
// /opencms/importexport/import/immutables
StringBuffer xp = new StringBuffer(256);
xp.append("/").append(CmsConfigurationManager.N_ROOT);
xp.append("/").append(CmsImportExportConfiguration.N_IMPORTEXPORT);
xp.append("/").append(CmsImportExportConfiguration.N_IMPORT);
xp.append("/").append(CmsImportExportConfiguration.N_IMMUTABLES);
return xp.toString();
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getXPathsToUpdate()
*/
@Override
protected List getXPathsToUpdate() {
if (m_xpaths == null) {
// "/opencms/importexport/import/immutables/resource[@uri='...']";
StringBuffer xp = new StringBuffer(256);
xp.append("/").append(CmsConfigurationManager.N_ROOT);
xp.append("/").append(CmsImportExportConfiguration.N_IMPORTEXPORT);
xp.append("/").append(CmsImportExportConfiguration.N_IMPORT);
xp.append("/").append(CmsImportExportConfiguration.N_IMMUTABLES);
xp.append("/").append(I_CmsXmlConfiguration.N_RESOURCE);
xp.append("[@").append(I_CmsXmlConfiguration.A_URI);
xp.append("='");
m_xpaths = new ArrayList();
m_xpaths.add(xp.toString() + "/system/categories/']");
}
return m_xpaths;
}
}