Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.core.CmsException JAVADOC | Sourc code of com.opencms.core.CmsException SOURCE | Download com.opencms.core.CmsException DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opencms.core
Class CmsException  view CmsException download CmsException.java

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.opencms.core.CmsException
All Implemented Interfaces:
java.io.Serializable
public class CmsException
extends java.lang.Exception

This class provides OpenCms interal Exception handling. A CmsExeption thrown will result in a default OpenCms error dialog box.

Note: Most Exceptions thrown in templates and other classes will be converted to a CmsException by the template launcher.

Version:
$Revision: 1.48 $ $Date: 2002/11/17 16:42:56 $

Nested Class Summary
 
Nested classes inherited from class java.lang.Throwable
 
Field Summary
static int C_ACCESS_DENIED
          Definition of error code for access denied exception for file resources.
static int C_BAD_NAME
          Definition of error code for bad name exception
static int C_CLASSLOADER_ERROR
          Definition of error code for launcher errors
static java.lang.String C_CMS_EXCEPTION_PREFIX
          Default prefix for a CmsException message
static java.lang.String[] C_EXTXT
          This array provides descriptions for the error codes stored as constants in the CmsExeption class.
static int C_FILE_EXISTS
          Definition of error code for file exists exception
static int C_FILESYSTEM_ERROR
          Definition of error code filesystem error
static int C_FLEX_CACHE
          Error code for Flex cache
static int C_FLEX_LOADER
          Error code for Flex loader
static int C_FLEX_OTHER
          Unspecified Flex error code
static int C_GROUP_NOT_EMPTY
          Definition of error code for group not empty exception
static int C_HTTPS_PAGE_ERROR
          Definition of error code for HTTP sreaming error
static int C_HTTPS_REQUEST_ERROR
          Definition of error code for HTTP sreaming error
static int C_INTERNAL_FILE
          Definition of error code internal file
static int C_INVALID_PASSWORD
          Definition of error code for error"Password not valid".
static int C_LAUNCH_ERROR
          Definition of error code for launcher errors
static int C_LOCKED
          Definition of error code for locked resource
static int C_NO_ACCESS
          Definition of error code for access denied exception for non file resources
static int C_NO_DEFAULT_GROUP
          Definition of error code for no default group exception
static int C_NO_GROUP
          Definition of error code for no group exception
static int C_NO_USER
          Definition of error code for no user exception
static int C_NOT_ADMIN
          Definition of error code for no admin exception
static int C_NOT_EMPTY
          Definition of error code for not empty exception
static int C_NOT_FOUND
          Definition of error code for not found exception
static int C_RB_INIT_ERROR
          Definition of error code for RB-INIT-ERRORS
static int C_REGISTRY_ERROR
          Definition of error code for Registry exception
static int C_RESOURCE_DELETED
          Definition of error code for accessing a deleted resource
static int C_SERIALIZATION
          Definition of error code for serialization exception
static int C_SERVICE_UNAVAILABLE
          Definition of error code service unavailable
static int C_SHORT_PASSWORD
          Definition of error code for error"Password too short"
static int C_SQL_ERROR
          Definition of error code for sql exception
static int C_STREAMING_ERROR
          Definition of error code for HTTP sreaming error
static int C_UNKNOWN_EXCEPTION
          Definition of error code for unknown exception
static int C_USER_EXISTS
          Definition of error code for user exists
static int C_XML_CORRUPT_INTERNAL_STRUCTURE
          Definition of error code for corrupt internal structure
static int C_XML_NO_PROCESS_METHOD
          Definition of error code for XML process method not found
static int C_XML_NO_TEMPLATE_CLASS
          Definition of error code for no XML template class
static int C_XML_NO_USER_METHOD
          Definition of error code for XML user method not found
static int C_XML_PARSING_ERROR
          Definition of error code for XML parsing error
static int C_XML_PROCESS_ERROR
          Definition of error code for XML processing error
static int C_XML_TAG_MISSING
          Definition of error code for missing XML tag
static int C_XML_UNKNOWN_DATA
          Definition of error code for unknown XML datablocks
static int C_XML_WRONG_CONTENT_TYPE
          Definition of error code for wrong XML content type
static int C_XML_WRONG_TEMPLATE_CLASS
          Definition of error code for wrong XML template class
protected  java.lang.String m_message
          A string message describing the CmsEception
protected  java.lang.Throwable m_rootCause
          Stores a forwared exception
protected  int m_type
          Stores the error code of the CmsException
protected  boolean m_useRootCause
          Flag to set processing of a saved forwared root exception
 
Fields inherited from class java.lang.Exception
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
CmsException()
          Constructs a simple CmsException
CmsException(int type)
          Contructs a CmsException with the provided error code, The error codes used should be the constants from the CmsEception class.
CmsException(int type, java.lang.Throwable rootCause)
          Contructs a CmsException with the provided error code and a given root cause.
CmsException(java.lang.String message)
          Constructs a CmsException with the provided description.
CmsException(java.lang.String message, int type)
          Contructs a CmsException with the provided description and error code.
CmsException(java.lang.String message, int type, java.lang.Throwable rootCause)
          Creates a CmsException with the provided error code, a forwarded root cause exception and a detail message.
CmsException(java.lang.String message, int type, java.lang.Throwable rootCause, boolean useRoot)
          Creates a CmsException with a provided error code, a forwarded root cause exception and a detail message.
CmsException(java.lang.String message, java.lang.Throwable rootCause)
          Construtcs a CmsException with a detail message and a forwarded root cause exception
 
Method Summary
 java.lang.Exception getException()
          Get the root cause Exception which was provided when this exception was thrown.
 java.lang.String getMessage()
          Get the exeption message
 java.lang.Throwable getRootCause()
          Get the root cause Throwable which was provided when this exception was thrown.
 java.lang.String getShortException()
          Get the exeption message
 java.lang.String getStackTraceAsString()
          Return a string with the stacktrace.
 java.lang.Throwable getThrowable()
          Get the throwable.
 int getType()
          Get the type of the CmsException.
 java.lang.String getTypeText()
          Gets the exception type as text.
 void printStackTrace()
          Print the exception stack trace to System.out.
 void printStackTrace(java.io.PrintStream s)
          Prints this Throwable and its backtrace to the specified print stream.
 void printStackTrace(java.io.PrintWriter s)
          Prints this Throwable and its backtrace to the specified print writer.
 void setException(java.lang.Throwable value)
          Set the root cause Exception value.
 java.lang.String toString()
          Overwrites the standart toString method.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_type

protected int m_type
Stores the error code of the CmsException

m_message

protected java.lang.String m_message
A string message describing the CmsEception

m_rootCause

protected java.lang.Throwable m_rootCause
Stores a forwared exception

m_useRootCause

protected boolean m_useRootCause
Flag to set processing of a saved forwared root exception

C_UNKNOWN_EXCEPTION

public static final int C_UNKNOWN_EXCEPTION
Definition of error code for unknown exception

See Also:
Constant Field Values

C_NO_ACCESS

public static final int C_NO_ACCESS
Definition of error code for access denied exception for non file resources

See Also:
Constant Field Values

C_NOT_FOUND

public static final int C_NOT_FOUND
Definition of error code for not found exception

See Also:
Constant Field Values

C_BAD_NAME

public static final int C_BAD_NAME
Definition of error code for bad name exception

See Also:
Constant Field Values

C_SQL_ERROR

public static final int C_SQL_ERROR
Definition of error code for sql exception

See Also:
Constant Field Values

C_NOT_EMPTY

public static final int C_NOT_EMPTY
Definition of error code for not empty exception

See Also:
Constant Field Values

C_NOT_ADMIN

public static final int C_NOT_ADMIN
Definition of error code for no admin exception

See Also:
Constant Field Values

C_SERIALIZATION

public static final int C_SERIALIZATION
Definition of error code for serialization exception

See Also:
Constant Field Values

C_NO_GROUP

public static final int C_NO_GROUP
Definition of error code for no group exception

See Also:
Constant Field Values

C_GROUP_NOT_EMPTY

public static final int C_GROUP_NOT_EMPTY
Definition of error code for group not empty exception

See Also:
Constant Field Values

C_NO_USER

public static final int C_NO_USER
Definition of error code for no user exception

See Also:
Constant Field Values

C_NO_DEFAULT_GROUP

public static final int C_NO_DEFAULT_GROUP
Definition of error code for no default group exception

See Also:
Constant Field Values

C_FILE_EXISTS

public static final int C_FILE_EXISTS
Definition of error code for file exists exception

See Also:
Constant Field Values

C_LOCKED

public static final int C_LOCKED
Definition of error code for locked resource

See Also:
Constant Field Values

C_FILESYSTEM_ERROR

public static final int C_FILESYSTEM_ERROR
Definition of error code filesystem error

See Also:
Constant Field Values

C_INTERNAL_FILE

public static final int C_INTERNAL_FILE
Definition of error code internal file

See Also:
Constant Field Values

C_SERVICE_UNAVAILABLE

public static final int C_SERVICE_UNAVAILABLE
Definition of error code service unavailable

See Also:
Constant Field Values

C_XML_UNKNOWN_DATA

public static final int C_XML_UNKNOWN_DATA
Definition of error code for unknown XML datablocks

See Also:
Constant Field Values

C_XML_CORRUPT_INTERNAL_STRUCTURE

public static final int C_XML_CORRUPT_INTERNAL_STRUCTURE
Definition of error code for corrupt internal structure

See Also:
Constant Field Values

C_XML_WRONG_CONTENT_TYPE

public static final int C_XML_WRONG_CONTENT_TYPE
Definition of error code for wrong XML content type

See Also:
Constant Field Values

C_XML_PARSING_ERROR

public static final int C_XML_PARSING_ERROR
Definition of error code for XML parsing error

See Also:
Constant Field Values

C_XML_PROCESS_ERROR

public static final int C_XML_PROCESS_ERROR
Definition of error code for XML processing error

See Also:
Constant Field Values

C_XML_NO_USER_METHOD

public static final int C_XML_NO_USER_METHOD
Definition of error code for XML user method not found

See Also:
Constant Field Values

C_XML_NO_PROCESS_METHOD

public static final int C_XML_NO_PROCESS_METHOD
Definition of error code for XML process method not found

See Also:
Constant Field Values

C_XML_TAG_MISSING

public static final int C_XML_TAG_MISSING
Definition of error code for missing XML tag

See Also:
Constant Field Values

C_XML_WRONG_TEMPLATE_CLASS

public static final int C_XML_WRONG_TEMPLATE_CLASS
Definition of error code for wrong XML template class

See Also:
Constant Field Values

C_XML_NO_TEMPLATE_CLASS

public static final int C_XML_NO_TEMPLATE_CLASS
Definition of error code for no XML template class

See Also:
Constant Field Values

C_LAUNCH_ERROR

public static final int C_LAUNCH_ERROR
Definition of error code for launcher errors

See Also:
Constant Field Values

C_CLASSLOADER_ERROR

public static final int C_CLASSLOADER_ERROR
Definition of error code for launcher errors

See Also:
Constant Field Values

C_SHORT_PASSWORD

public static final int C_SHORT_PASSWORD
Definition of error code for error"Password too short"

See Also:
Constant Field Values

C_INVALID_PASSWORD

public static final int C_INVALID_PASSWORD
Definition of error code for error"Password not valid". For comptibility reasons the same like for short password.

See Also:
Constant Field Values

C_ACCESS_DENIED

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

See Also:
Constant Field Values

C_RESOURCE_DELETED

public static final int C_RESOURCE_DELETED
Definition of error code for accessing a deleted resource

See Also:
Constant Field Values

C_RB_INIT_ERROR

public static final int C_RB_INIT_ERROR
Definition of error code for RB-INIT-ERRORS

See Also:
Constant Field Values

C_REGISTRY_ERROR

public static final int C_REGISTRY_ERROR
Definition of error code for Registry exception

See Also:
Constant Field Values

C_USER_EXISTS

public static final int C_USER_EXISTS
Definition of error code for user exists

See Also:
Constant Field Values

C_STREAMING_ERROR

public static final int C_STREAMING_ERROR
Definition of error code for HTTP sreaming error

See Also:
Constant Field Values

C_HTTPS_PAGE_ERROR

public static final int C_HTTPS_PAGE_ERROR
Definition of error code for HTTP sreaming error

See Also:
Constant Field Values

C_HTTPS_REQUEST_ERROR

public static final int C_HTTPS_REQUEST_ERROR
Definition of error code for HTTP sreaming error

See Also:
Constant Field Values

C_FLEX_CACHE

public static final int C_FLEX_CACHE
Error code for Flex cache

See Also:
Constant Field Values

C_FLEX_LOADER

public static final int C_FLEX_LOADER
Error code for Flex loader

See Also:
Constant Field Values

C_FLEX_OTHER

public static final int C_FLEX_OTHER
Unspecified Flex error code

See Also:
Constant Field Values

C_CMS_EXCEPTION_PREFIX

public static final java.lang.String C_CMS_EXCEPTION_PREFIX
Default prefix for a CmsException message

See Also:
Constant Field Values

C_EXTXT

public static final java.lang.String[] C_EXTXT
This array provides descriptions for the error codes stored as constants in the CmsExeption class.

Constructor Detail

CmsException

public CmsException()
Constructs a simple CmsException

CmsException

public CmsException(int type)
Contructs a CmsException with the provided error code, The error codes used should be the constants from the CmsEception class.

CmsException

public CmsException(int type,
                    java.lang.Throwable rootCause)
Contructs a CmsException with the provided error code and a given root cause. The error codes used should be the constants from the CmsEception class.

CmsException

public CmsException(java.lang.String message)
Constructs a CmsException with the provided description.

CmsException

public CmsException(java.lang.String message,
                    int type)
Contructs a CmsException with the provided description and error code.

CmsException

public CmsException(java.lang.String message,
                    java.lang.Throwable rootCause)
Construtcs a CmsException with a detail message and a forwarded root cause exception

CmsException

public CmsException(java.lang.String message,
                    int type,
                    java.lang.Throwable rootCause)
Creates a CmsException with the provided error code, a forwarded root cause exception and a detail message.

CmsException

public CmsException(java.lang.String message,
                    int type,
                    java.lang.Throwable rootCause,
                    boolean useRoot)
Creates a CmsException with a provided error code, a forwarded root cause exception and a detail message. The further processing of the exception can be controlled with the useRoot parameter.

Method Detail

getException

public java.lang.Exception getException()
Get the root cause Exception which was provided when this exception was thrown.

getRootCause

public java.lang.Throwable getRootCause()
Get the root cause Throwable which was provided when this exception was thrown.

setException

public void setException(java.lang.Throwable value)
Set the root cause Exception value.

getThrowable

public java.lang.Throwable getThrowable()
Get the throwable.

getMessage

public java.lang.String getMessage()
Get the exeption message

getShortException

public java.lang.String getShortException()
Get the exeption message

getStackTraceAsString

public java.lang.String getStackTraceAsString()
Return a string with the stacktrace. for this exception and for all encapsulated exceptions. Creation date: (10/23/00 %r)

getType

public int getType()
Get the type of the CmsException.

getTypeText

public java.lang.String getTypeText()
Gets the exception type as text.

printStackTrace

public void printStackTrace()
Print the exception stack trace to System.out.

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Prints this Throwable and its backtrace to the specified print stream.

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Prints this Throwable and its backtrace to the specified print writer.

toString

public java.lang.String toString()
Overwrites the standart toString method.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.core.CmsException JAVADOC | Sourc code of com.opencms.core.CmsException SOURCE | Download com.opencms.core.CmsException DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD