Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.deltava.util.ControllerException

org.deltava.service.ServiceException

All Implemented Interfaces:

Serializable

public class ServiceException
extends ControllerException

An Exception thrown by Web Services.

Since:

1.0

Version:

9.0

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServiceException(int code, String msg)	Creates a new Web Service Exception.
ServiceException(int code, String msg, boolean dumpStack)	Creates a new Web Service Exception.
ServiceException(int code, String msg, Throwable t)	Creates a new Web Service Exception from an existing exception.

Method Summary

Modifier and Type	Method	Description
int	getCode()	Returns the HTTP result code.

Methods inherited from class ControllerException

getForwardURL, getLogStackDump, getStatusCode, isSuppressed, isWarning, setForwardURL, setLogStackDump, setStatusCode, setSuppressed, setWarning

Modifier and Type	Method	Description
String	getForwardURL()	Returns the URL that the Controller servlet should forward the request to.
boolean	getLogStackDump()	Returns whether the handling class should log this Exception's stack trace.
int	getStatusCode()	Returns the HTTP status code to set on the error page.
boolean	isSuppressed()	Returns whether this exception should not be logged.
boolean	isWarning()	Returns whether this exception to be logged as a warning, not an error.
void	setForwardURL(String url)	Updates the URL that the Controller servlet should forward the request to.
void	setLogStackDump(boolean doLog)	Updates whether the handling class should log this Exception's stack trace.
void	setStatusCode(int code)	Sets the HTTP status code to set on the error page.
void	setSuppressed(boolean isSuppress)	Sets this exception to not be logged.
void	setWarning(boolean isWarn)	Sets this exception to be logged as a warning, not an error.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

ServiceException

ServiceException(int code,
 String msg,
 Throwable t)

Creates a new Web Service Exception from an existing exception.

Parameters:

code - the HTTP result code

msg - the exception message

t - the existing exception

ServiceException

ServiceException(int code,
 String msg)

Creates a new Web Service Exception.

Parameters:

code - the HTTP result code

msg - the exception message

ServiceException

ServiceException(int code,
 String msg,
 boolean dumpStack)

Creates a new Web Service Exception.

Parameters:

code - the HTTP result code

msg - the exception message

dumpStack - TRUE if the stack should be dumped, otherwise FALSE

Method Details

getCode

public int getCode()

Returns the HTTP result code.

Returns:

the HTTP result code