com.groiss.util

Class ApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.groiss.util.ApplicationException

All Implemented Interfaces:

TopLevelException, Serializable

public class ApplicationException
extends RuntimeException
implements TopLevelException

Class for Exceptions thrown in the application.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationException.Level Level for logging the exception.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	addText
protected boolean	allowHTMLMessage
protected Object[]	arguments
protected ErrorFormatter	ef
static String	EXCEPTION_MARKER
protected int	exceptionNumber
protected boolean	isWarning
protected String	title
static String	WRAPPER_MARKER

Constructor Summary

Constructors

Constructor and Description
ApplicationException(int errnum) Construct an ApplicationException with an exception number.
ApplicationException(int errnum, ApplicationException.Level level) Construct an ApplicationException with an exception number.
ApplicationException(int errnum, Object[] args) Construct an ApplicationException with an exception number and args
ApplicationException(int errnum, Object[] args, Throwable cause) Construct an ApplicationException with an exception number, args and the cause exception.
ApplicationException(int errnum, Object[] args, Throwable cause, ApplicationException.Level level) Construct an ApplicationException with an exception number, args and the cause exception.
ApplicationException(int errnum, String msg, Throwable cause) Deprecated. Don't use this signature, use placeholders and an argument array.
ApplicationException(int errnum, Throwable cause) Construct an ApplicationException with an exception number and the cause exception.
ApplicationException(Resource resource, int errnum) Construct an ApplicationException with an exception number and a resource.
ApplicationException(Resource resource, int errnum, Object[] args) Construct an ApplicationException with a resource, exception number and args.
ApplicationException(Resource resource, int errnum, Object[] args, Throwable cause) Construct an ApplicationException with a resource, exception number, args and the cause exception.
ApplicationException(Resource resource, int errnum, String msg, Throwable cause) Deprecated. Don't use this signature, use placeholders and an argument array.
ApplicationException(Resource resource, int errnum, Throwable cause) Construct an ApplicationException with a resource, exception number, and the cause exception.
ApplicationException(String message) Construct an ApplicationException with a message.
ApplicationException(String message, Throwable cause) Construct an ApplicationException with a message and the cause exception.
ApplicationException(String message, Throwable cause, ApplicationException.Level level) Construct an ApplicationException with a message and the cause exception.
ApplicationException(Throwable cause) Construct an ApplicationException with a cause exception.

Method Summary

Modifier and Type	Method and Description
boolean	allowHTMLMessage()
Object[]	getArgs()
static Class<?>	getCallingClass() Returns the name of the class which called the invoking method.
int	getErrnum()
ErrorFormatter	getErrorFormatter() Returns the error formatter for this exception.
Throwable	getException() Returns an inner exception, null if there is none.
String	getMessage()
String	getMessageText() return the plain message text without "Error" prefix and number
String	getTitle() get the title used for the error-popup on clientside
boolean	isWarning()
protected void	log(String marker, ApplicationException.Level level, org.slf4j.Logger logger) The cause is logged.
void	setAllowHTMLMessage(boolean allowHTMLMessage) set to true to allow html-formatted error-messages, false by default
void	setErrorFormatter(ErrorFormatter ef) Set the formatter for formatting the error page.
ApplicationException	setTitle(String title) set title of error-popup on clientside
void	setWarning(boolean warning) Set the exception type to warning.
static ApplicationException	wrap(Throwable cause) Conditionally wrap an exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 Detail

EXCEPTION_MARKER

public static final String EXCEPTION_MARKER

See Also:

Constant Field Values

WRAPPER_MARKER

public static final String WRAPPER_MARKER

See Also:

Constant Field Values

ef

protected transient ErrorFormatter ef

exceptionNumber

protected int exceptionNumber

arguments

protected transient Object[] arguments

isWarning

protected boolean isWarning

allowHTMLMessage

protected boolean allowHTMLMessage

addText

protected String addText

title

protected String title

Constructor Detail

ApplicationException

public ApplicationException(int errnum)

Construct an ApplicationException with an exception number.

Parameters:

errnum - the key in the enterprise errors resource

ApplicationException

public ApplicationException(int errnum,
                            ApplicationException.Level level)

Construct an ApplicationException with an exception number.

Parameters:

errnum - the key in the enterprise errors resource

level - level for logging the exception, default is ERROR

ApplicationException

public ApplicationException(int errnum,
                            Object[] args)

Construct an ApplicationException with an exception number and args

Parameters:

errnum - the key in the given resource

args - message-format arguments

ApplicationException

public ApplicationException(int errnum,
                            Object[] args,
                            Throwable cause)

Construct an ApplicationException with an exception number, args and the cause exception.

Parameters:

errnum - the key in the given resource

args - message-format arguments

cause - the causing exception

ApplicationException

public ApplicationException(int errnum,
                            Object[] args,
                            Throwable cause,
                            ApplicationException.Level level)

Construct an ApplicationException with an exception number, args and the cause exception.

Parameters:

errnum - the key in the given resource

args - message-format arguments

cause - the causing exception

level - level for logging the exception, default is ERROR

ApplicationException

public ApplicationException(int errnum,
                            Throwable cause)

Construct an ApplicationException with an exception number and the cause exception.

Parameters:

errnum - the key in the given resource

cause - the causing exception

ApplicationException

public ApplicationException(String message)

Construct an ApplicationException with a message.

Parameters:

message - the error message

ApplicationException

public ApplicationException(String message,
                            Throwable cause)

Construct an ApplicationException with a message and the cause exception.

Parameters:

message - the error message

cause - the causing exception

ApplicationException

public ApplicationException(String message,
                            Throwable cause,
                            ApplicationException.Level level)

Construct an ApplicationException with a message and the cause exception.

Parameters:

message - the error message

cause - the causing exception

level - level for logging the exception, default is ERROR

ApplicationException

public ApplicationException(Throwable cause)

Construct an ApplicationException with a cause exception.

Parameters:

cause - the causing exception

ApplicationException

public ApplicationException(Resource resource,
                            int errnum)

Construct an ApplicationException with an exception number and a resource.

Parameters:

resource - a resource containing the error messages.

errnum - the key in the given resource

ApplicationException

public ApplicationException(Resource resource,
                            int errnum,
                            Object[] args)

Construct an ApplicationException with a resource, exception number and args.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

args - message-format arguments

ApplicationException

public ApplicationException(Resource resource,
                            int errnum,
                            Object[] args,
                            Throwable cause)

Construct an ApplicationException with a resource, exception number, args and the cause exception.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

args - message-format arguments

cause - the causing exception

ApplicationException

public ApplicationException(Resource resource,
                            int errnum,
                            Throwable cause)

Construct an ApplicationException with a resource, exception number, and the cause exception.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

cause - the causing exception

ApplicationException

@Deprecated
public ApplicationException(int errnum,
                                        String msg,
                                        Throwable cause)

Deprecated. Don't use this signature, use placeholders and an argument array.

Construct an ApplicationException with an exception number, an extra message and the cause exception.

Parameters:

errnum - the key in the given resource

msg - text that is added to the message from the error resource.

cause - the causing exception

ApplicationException

@Deprecated
public ApplicationException(Resource resource,
                                        int errnum,
                                        String msg,
                                        Throwable cause)

Deprecated. Don't use this signature, use placeholders and an argument array.

Construct an ApplicationException with a resource, an exception number, an extra message and the cause exception.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

msg - text that is added to the message from the error resource.

cause - the causing exception

Method Detail

wrap

public static ApplicationException wrap(Throwable cause)

Conditionally wrap an exception. If the cause is already an ApplicationException, it is returned directly without any further wrapping. All other types of causes result in a new ApplicationException which is wrapping the cause.

Parameters:

cause - the causing Exception

Returns:

the potentially wrapped ApplicationException

getCallingClass

public static Class<?> getCallingClass()

Returns the name of the class which called the invoking method.

Returns:

the name of the class which called the invoking method.

getArgs

public Object[] getArgs()

getErrnum

public int getErrnum()

Specified by:

getErrnum in interface TopLevelException

getErrorFormatter

public ErrorFormatter getErrorFormatter()

Returns the error formatter for this exception. If none is set, the method return null and the default ErrorFormatter defined in the system configuration will be used. If none is defined, DefaultErrorFormatter is used.

Returns:

the error formatter set for this exception.

getException

public Throwable getException()

Description copied from interface: TopLevelException

Returns an inner exception, null if there is none.

Specified by:

getException in interface TopLevelException

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getMessageText

public String getMessageText()

return the plain message text without "Error" prefix and number

log

protected void log(String marker,
                   ApplicationException.Level level,
                   org.slf4j.Logger logger)

The cause is logged. If there is no cause, the exception is written as info

setErrorFormatter

public void setErrorFormatter(ErrorFormatter ef)

Set the formatter for formatting the error page.

Parameters:

ef -

allowHTMLMessage

public boolean allowHTMLMessage()

setAllowHTMLMessage

public void setAllowHTMLMessage(boolean allowHTMLMessage)

set to true to allow html-formatted error-messages, false by default

Parameters:

allowHTMLMessage -

setTitle

public ApplicationException setTitle(String title)

set title of error-popup on clientside

Parameters:

title -

getTitle

public String getTitle()

get the title used for the error-popup on clientside

Returns:

setWarning

public void setWarning(boolean warning)

Set the exception type to warning. This can be interpreted in the GUI to show the error message differently.

Specified by:

setWarning in interface TopLevelException

isWarning

public boolean isWarning()

Specified by:

isWarning in interface TopLevelException