cmsexception.java

来自「java 编写的程序」· Java 代码 · 共 499 行

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/core/CmsException.java,v $
* Date   : $Date: 2002/05/10 20:10:42 $
* Version: $Revision: 1.45 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* 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 OpenCms, please see the
* OpenCms 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 com.opencms.core;

import java.io.*;
import java.util.*;

/**
 * This exception is thrown for security reasons in the Cms.
 *
 * @author Michael Emmerich
 * @version $Revision: 1.45 $ $Date: 2002/05/10 20:10:42 $
 */
public class CmsException extends Exception {

    /**
     * Stores the error code of the CmsException.
     */
    protected int m_Type = 0;
    protected String m_message = "NO MESSAGE";

    /**
     * Stores a forwared exception.
     */
    protected Exception m_Exception = null;

    /**
     * Definition of error code for unknown exception.
     */
    public final static int C_UNKNOWN_EXCEPTION = 0;

    /**
     * Definition of error code for access denied exception for non file resources.
     */
    public final static int C_NO_ACCESS = 1;

    /**
     * Definition of error code for not found exception.
     */
    public final static int C_NOT_FOUND = 2;

    /**
     * Definition of error code for bad name exception.
     */
    public final static int C_BAD_NAME = 3;

    /**
     * Definition of error code for sql exception.
     */
    public final static int C_SQL_ERROR = 4;

    /**
     * Definition of error code for not empty exception.
     */
    public final static int C_NOT_EMPTY = 5;

    /**
     * Definition of error code for no admin exception.
     */
    public final static int C_NOT_ADMIN = 6;

    /**
     * Definition of error code for serialization exception.
     */
    public final static int C_SERIALIZATION = 7;

    /**
     * Definition of error code for no group exception.
     */
    public final static int C_NO_GROUP = 8;

    /**
     * Definition of error code for group not empty exception.
     */
    public final static int C_GROUP_NOT_EMPTY = 9;

    /**
     * Definition of error code for no user exception.
     */
    public final static int C_NO_USER = 10;

    /**
     * Definition of error code for no default group exception.
     */
    public final static int C_NO_DEFAULT_GROUP = 11;

    /**
     * Definition of error code for file exists exception.
     */
    public final static int C_FILE_EXISTS = 12;

    /**
     * Definition of error code for locked resource.
     */
    public final static int C_LOCKED = 13;

    /**
     * Definition of error code filesystem error.
     */
    public final static int C_FILESYSTEM_ERROR = 14;

    /**
     * Definition of error code internal file.
     */
    public final static int C_INTERNAL_FILE = 15;

    /**
     * Definition of error code service unavailable.
     */
    public final static int C_SERVICE_UNAVAILABLE = 17;

    /**
     * Definition of error code for unknown XML datablocks
     */
    public final static int C_XML_UNKNOWN_DATA = 18;

    /**
     * Definition of error code for corrupt internal structure.
     */
    public final static int C_XML_CORRUPT_INTERNAL_STRUCTURE = 19;

    /**
     * Definition of error code for wrong XML content type.
     */
    public final static int C_XML_WRONG_CONTENT_TYPE = 20;

    /**
     * Definition of error code for XML parsing error.
     */
    public final static int C_XML_PARSING_ERROR = 21;

    /**
     * Definition of error code for XML processing error.
     */
    public final static int C_XML_PROCESS_ERROR = 22;

    /**
     * Definition of error code for XML user method not found.
     */
    public final static int C_XML_NO_USER_METHOD = 23;

    /**
     * Definition of error code for XML process method not found.
     */
    public final static int C_XML_NO_PROCESS_METHOD = 24;

    /**
     * Definition of error code for missing XML tag.
     */
    public final static int C_XML_TAG_MISSING = 25;

    /**
     * Definition of error code for wrong XML template class.
     */
    public final static int C_XML_WRONG_TEMPLATE_CLASS = 26;

    /**
     * Definition of error code for no XML template class.
     */
    public final static int C_XML_NO_TEMPLATE_CLASS = 27;

    /**
     * Definition of error code for launcher errors.
     */
    public final static int C_LAUNCH_ERROR = 28;

    /**
     * Definition of error code for launcher errors.
     */
    public final static int C_CLASSLOADER_ERROR = 29;

    /**
     * Definition of error code for error"Password too short".
     */
    public final static int C_SHORT_PASSWORD = 30;

    /**
     * Definition of error code for access denied exception for file resources.
     * This exception causes a login-screen.
     */
    public final static int C_ACCESS_DENIED = 31;

    /**
     * Definition of error code for accessing a deleted resource
     */
    public final static int C_RESOURCE_DELETED = 32;

    /**
     * Definition of error code for RB-INIT-ERRORS
     */
    public final static int C_RB_INIT_ERROR = 33;

    /**
     * Definition of error code for Registry exception
     */
    public final static int C_REGISTRY_ERROR = 34;

    /**
     * Definition of error code for user exists
     */
    public final static int C_USER_EXISTS = 35;
    /**
     * Definition of error code for HTTP sreaming error
     */
    public final static int C_STREAMING_ERROR = 36;
    /**
     * Definition of error code for HTTP sreaming error
     */
    public final static int C_HTTPS_PAGE_ERROR = 37;
    /**
     * Definition of error code for HTTP sreaming error
     */
    public final static int C_HTTPS_REQUEST_ERROR = 38;
    
    /**
     * Error code for Flex cache
     */
    public final static int C_FLEX_CACHE = 39;    
    /**
     * Error code for Flex loader
     */
    public final static int C_FLEX_LOADER = 40;
    /**
     * Unspecified Flex error code
     */
    public final static int C_FLEX_OTHER = 41;
    
    
    public final static String C_EXTXT[] =  {
        "Unknown exception", "Access denied", "Not found",
        "Bad name", "Sql exception", "Folder not empty", "Admin access required",
        "Serialization/Deserialization failed", "Unknown User Group",
        "Group not empty", "Unknown User", "No removal from Default Group",
        "Resource already exists", "Locked Resource", "Filesystem exception",
        "Internal use only", "Deprecated exception: File-property is mandatory",
        "Service unavailable", "Unknown XML datablock", "Corrupt internal structure",
        "Wrong XML content type", "XML parsing error", "Could not process OpenCms special XML tag",
        "Could not call user method", "Could not call process method",
        "XML tag missing", "Wrong XML template class", "No XML template class",
        "Error while launching template class", "OpenCms class loader error",
        "New password is too short", "Access denied to resource",
        "Resource deleted", "Resourcebroker-init error", "Registry error",
        "User already exists", "HTTP streaming error",
        "Wrong scheme for http resource", "Wrong scheme for https resource",
        "Error in Flex cache", "Error in Flex loader", "Error in Flex engine"
    };

    /**
     * Constructs a simple CmsException
     */
    public CmsException() {
        super();
    }

    /**
     * Contructs a CmsException with reserved error code
     * <p>
     *
     * @param i Exception code
     */
    public CmsException(int i) {
        super("CmsException ID: " + i);
        m_Type = i;
    }

    /**
     * Creates a CmsException with reserved error code and a forwarded other exception
     * <p>
     *
     * @param i Exception code
     * @param e Forawarded general exception
     */
    public CmsException(int i, Exception e) {
        super("CmsException ID: " + i);
        m_Type = i;
        m_Exception = e;
    }

    /**
     * Constructs a CmsException with a specified description.
     *
     * @param s Exception description
     */
    public CmsException(String s) {
        super(s);
        m_message = s;
    }

    /**
     * Constructs a  CmsException with reserved error code and additional information
     * <p>
     *
     * @param s Exception description
     * @param i Exception code
     */
    public CmsException(String s, int i) {
        super(s);
        m_Type = i;
        m_message = s;
    }

    /**
     * Creates a CmsException with reserved error code, a forwarded other exception and a detail message
     * <p>
     *
     * @param s Exception description
     * @param i Exception code
     * @param e Forawarded general exception
     */
    public CmsException(String s, int i, Exception e) {
        super(s);
        m_Type = i;
        m_Exception = e;
        m_message = s;
    }

    /**
     * Construtcs a CmsException  with a detail message and a forwarded other exception
     *
     * @param s Exception description
     * @param e Forwaarded general exception
     */
    public CmsException(String s, Exception e) {
        super(s);
        m_Exception = e;
        m_message = s;
    }

    /**
     * Get the exeption.
     *
     * @return Exception.
     */
    public Exception getException() {
        return m_Exception;
    }

    /**
     * Get the exeption message
     *
     * @return Exception messge.
     */
    public String getMessage() {
        return m_message;
    }

    /**
     * Get the exeption message
     *
     * @return Exception messge.
     */
    public String getShortException() {
        return "[CmsException]: " + getType() + " " + C_EXTXT[getType()]
                + ". Detailed Error: " + m_message + ".";
    }

    /**
     * Return a string with the stacktrace. for this exception
     * and for all encapsulated exceptions.
     * Creation date: (10/23/00 %r)
     * @return java.lang.String
     */
    public String getStackTraceAsString() {
        java.io.StringWriter sw = new java.io.StringWriter();
        java.io.PrintWriter pw = new java.io.PrintWriter(sw);

        //now put all the StackTraces into the returning string
        super.printStackTrace(pw);

        //if there are any encapsulated exceptions, write them also.
        if(m_Exception != null) {
            StringWriter _sw = new StringWriter();
            PrintWriter _pw = new PrintWriter(_sw);
            m_Exception.printStackTrace(_pw);
            _pw.close();
            try {
                _sw.close();
            }
            catch(Exception exc) {


            // ignore the exception
            }
            StringTokenizer st = new StringTokenizer(_sw.toString(), "\n");
            while(st.hasMoreElements()) {
                pw.println(">" + st.nextElement());
            }
        }
        pw.close();
        try {
            sw.close();
        }
        catch(Exception exc) {


        // ignore the exception
        }
        return sw.toString();
    }

    /**
     * Get the type of the CmsException.
     *
     * @return Type of CmsException
     */
    public int getType() {
        return m_Type;
    }

    /**
     * Gets the exception type as text.
     *
     * @return Exception type in a text-version.
     */
    public String getTypeText() {
        return "[CmsException]: " + getType() + " " + C_EXTXT[getType()];
    }

    /**
     * Insert the method's description here.
     * Creation date: (10/23/00 %r)
     */
    public void printStackTrace() {
        printStackTrace(System.out);
    }

    /**
     * Prints this <code>Throwable</code> and its backtrace to the
     * specified print stream.
     *
     * @since   JDK1.0
     */
    public void printStackTrace(java.io.PrintStream s) {
        s.println(getStackTraceAsString());
    }

    /**
     * Prints this <code>Throwable</code> and its backtrace to the specified
     * print writer.
     *
     * @since   JDK1.1
     */
    public void printStackTrace(java.io.PrintWriter s) {
        s.println(getStackTraceAsString());
    }

    /**
     * Set an exception value.
     *
     * @param value Exception
     */
    public void setException(Exception value) {
        m_Exception = value;
    }

    /**
     * Overwrites the standart toString method.
     */
    public String toString() {
        StringBuffer output = new StringBuffer();
        output.append("[CmsException]: ");
        output.append(m_Type + " ");
        output.append(CmsException.C_EXTXT[m_Type] + ". ");
        output.append("Detailed Error: ");
        output.append(m_message + ". ");
        if(m_Exception != null) {
            output.append("Caught Exception: >");
            output.append(m_Exception + "<");
        }
        return output.toString();
    }
}