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.main;
029
030import org.opencms.i18n.CmsMessageContainer;
031
032/**
033 * Describes errors that occur in the context of OpenCms the initialization, this is fatal
034 * and prevents OpenCms from starting.<p>
035 *
036 * If an Exception of this class is thrown, OpenCms is set to an error state and
037 * the system won't try to start up again.<p>
038 *
039 * @since 6.0.0
040 */
041public class CmsInitException extends CmsRuntimeException {
042
043    /** Serial version UID required for safe serialization. */
044    private static final long serialVersionUID = 7705928617426913316L;
045
046    /** Indicates that this exception describes a new error. */
047    private boolean m_newError;
048
049    /**
050     * Creates a new localized Exception.<p>
051     *
052     * @param container the localized message container to use
053     */
054    public CmsInitException(CmsMessageContainer container) {
055
056        this(container, true);
057    }
058
059    /**
060     * Creates a new localized Exception.<p>
061     *
062     * @param container the localized message container to use
063     * @param newError indicates that the error is new, and OpenCms should be stopped
064     */
065    public CmsInitException(CmsMessageContainer container, boolean newError) {
066
067        super(container);
068        m_newError = newError;
069        if (m_newError) {
070            setErrorCondition();
071        }
072    }
073
074    /**
075     * Creates a new localized Exception that also containes a root cause.<p>
076     *
077     * @param container the localized message container to use
078     * @param cause the Exception root cause
079     */
080    public CmsInitException(CmsMessageContainer container, Throwable cause) {
081
082        super(container, cause);
083        m_newError = true;
084        setErrorCondition();
085    }
086
087    /**
088     * @see org.opencms.main.CmsRuntimeException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
089     */
090    @Override
091    public CmsRuntimeException createException(CmsMessageContainer container, Throwable cause) {
092
093        return new CmsInitException(container, cause);
094    }
095
096    /**
097     * Indicates that this exception describes a new error that was not already logged.<p>
098     *
099     * @return <code>true</code> if this exception describes a new error that was not already logged
100     */
101    public boolean isNewError() {
102
103        return m_newError;
104    }
105
106    /**
107     * Prints an error message to the System.err stream, indicating that OpenCms
108     * is unable to start up.<p>
109     */
110    private void setErrorCondition() {
111
112        CmsMessageContainer errorCondition = getMessageContainer();
113        OpenCmsCore.setErrorCondition(errorCondition);
114    }
115}