Package org.opencms.main

Class CmsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opencms.main.CmsException

All Implemented Interfaces:

Serializable, I_CmsThrowable

Direct Known Subclasses:

CmsConfigurationException, CmsDataAccessException, CmsFlexCacheException, CmsImportExportException, CmsIndexException, CmsInvalidActionException, CmsLoaderException, CmsLockException, CmsMessageException, CmsMultiException, CmsNewParentNotInWorkflowException, CmsPasswordEncryptionException, CmsPublishException, CmsResourceInitException, CmsRfsException, CmsSchedulerException, CmsSearchException, CmsSecurityException, CmsStaticExportException, CmsSynchronizeException, CmsWidgetException, CmsWorkplaceException, CmsXmlException

public class CmsException
extends Exception
implements I_CmsThrowable

Master exception type for all exceptions caused in OpenCms.

Since:

6.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsMessageContainer	m_message	The container for the localized message.

Constructor Summary

Constructors

Constructor	Description
CmsException(CmsMessageContainer message)	Creates a new localized Exception.
CmsException(CmsMessageContainer message, Throwable cause)	Creates a new localized Exception that also containers a root cause.

Method Summary

Modifier and Type	Method	Description
CmsException	createException(CmsMessageContainer container, Throwable cause)	Creates a copied instance of this localized exception.
static String	getFormattedErrorstack(Throwable t)	Returns the HTML formatted error stack of a Throwable.
String	getLocalizedMessage()	Returns a localized exception message based on the OpenCms default locale.
String	getLocalizedMessage(Locale locale)	Returns a localized exception message based on the given Locale.
String	getMessage()	Returns a localized exception message based on the OpenCms default locale.
CmsMessageContainer	getMessageContainer()	Returns the localized message container used to build this localized exception.
static String	getStackTraceAsString(Throwable e)	Returns the stack trace (including the message) of an exception as a String.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

m_message

protected CmsMessageContainer m_message

The container for the localized message.

Constructor Details

CmsException

public CmsException(CmsMessageContainer message)

Creates a new localized Exception.

Parameters:

message - the localized message container to use

CmsException

public CmsException(CmsMessageContainer message,
 Throwable cause)

Creates a new localized Exception that also containers a root cause.

Parameters:

message - the localized message container to use

cause - the Exception root cause

Method Details

getFormattedErrorstack

public static String getFormattedErrorstack(Throwable t)

Returns the HTML formatted error stack of a Throwable.

The error stack is used by the common error screen that is displayed if an error occurs.

Parameters:

t - the throwable to get the errorstack from

Returns:

the formatted value of the errorstack parameter

getStackTraceAsString

public static String getStackTraceAsString(Throwable e)

Returns the stack trace (including the message) of an exception as a String.

If the exception is a CmsException, also writes the root cause to the String.

Parameters:

e - the exception to get the stack trace from

Returns:

the stack trace of an exception as a String

createException

public CmsException createException(CmsMessageContainer container,
 Throwable cause)

Creates a copied instance of this localized exception.

Parameters:

container - the message container

cause - the root cause

Returns:

a copied instance of this localized exception

getLocalizedMessage

public String getLocalizedMessage()

Description copied from interface: I_CmsThrowable

Returns a localized exception message based on the OpenCms default locale.

Specified by:

getLocalizedMessage in interface I_CmsThrowable

Overrides:

getLocalizedMessage in class Throwable

Returns:

a localized exception message based on the OpenCms default locale

See Also:

• I_CmsThrowable.getLocalizedMessage()

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

Description copied from interface: I_CmsThrowable

Returns a localized exception message based on the given Locale.

Specified by:

getLocalizedMessage in interface I_CmsThrowable

Parameters:

locale - the Locale to get the message for

Returns:

a localized exception message based on the given Locale

See Also:

• I_CmsThrowable.getLocalizedMessage(Locale)

getMessage

public String getMessage()

Description copied from interface: I_CmsThrowable

Returns a localized exception message based on the OpenCms default locale.

Specified by:

getMessage in interface I_CmsThrowable

Overrides:

getMessage in class Throwable

Returns:

a localized exception message based on the OpenCms default locale

See Also:

• Throwable.getMessage()

getMessageContainer

public CmsMessageContainer getMessageContainer()

Description copied from interface: I_CmsThrowable

Returns the localized message container used to build this localized exception.

Specified by:

getMessageContainer in interface I_CmsThrowable

Returns:

the localized message container used to build this localized exception

See Also:

• I_CmsThrowable.getMessageContainer()