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.setup.comptest;
029
030import org.opencms.setup.CmsSetupBean;
031
032import org.dom4j.io.SAXReader;
033
034/**
035 * Test for the XML API.<p>
036 *
037 * @since 6.1.8
038 */
039public class CmsSetupTestXmlAPI implements I_CmsSetupTest {
040
041    /** The test name. */
042    public static final String TEST_NAME = "XML API";
043
044    /**
045     * @see org.opencms.setup.comptest.I_CmsSetupTest#getName()
046     */
047    public String getName() {
048
049        return TEST_NAME;
050    }
051
052    /**
053     * @see org.opencms.setup.comptest.I_CmsSetupTest#execute(org.opencms.setup.CmsSetupBean)
054     */
055    public CmsSetupTestResult execute(CmsSetupBean setupBean) throws Exception {
056
057        CmsSetupTestResult testResult = new CmsSetupTestResult(this);
058
059        SAXReader reader = new SAXReader();
060        Throwable exc = null;
061        try {
062            reader.setValidation(false);
063            reader.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
064        } catch (Throwable e) {
065            exc = e;
066        }
067
068        if (exc == null) {
069            testResult.setResult("passed");
070            testResult.setHelp(
071                "OpenCms requires Xerces version 2 to run. Usually this should be available as part of the servlet environment.");
072            testResult.setGreen();
073        } else {
074            testResult.setResult("not passed");
075            testResult.setRed();
076            testResult.setInfo(
077                "OpenCms requires Xerces XML API to be configured. "
078                    + "Be sure to set following Java System parameters:<br><pre>"
079                    + "javax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl\n"
080                    + "javax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl\n"
081                    + "javax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl\n"
082                    + "org.xml.sax.driver=org.apache.xerces.parsers.SAXParser</pre>");
083            testResult.setHelp(exc.getClass().getName() + ": " + exc.getMessage());
084        }
085        return testResult;
086    }
087}