org.nuxeo.ecm.webengine

Class WebException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.ws.rs.WebApplicationException

org.nuxeo.ecm.webengine.WebException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BoxRestException, IllegalParameterException, TypeException, WebDeployException, WebResourceNotFoundException, WebSecurityException

public class WebException
extends javax.ws.rs.WebApplicationException

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Throwable	cause
protected static org.apache.commons.logging.Log	log
protected String	message
protected int	status
protected String	type

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebException()
	WebException(int status)
	WebException(javax.ws.rs.core.Response.Status status)
	WebException(javax.ws.rs.core.Response response)
	WebException(String message)
	WebException(String message, int code)
	WebException(String message, Throwable cause)
	WebException(String message, Throwable cause, int status)
protected	WebException(Throwable cause)
protected	WebException(Throwable cause, int status)
protected	WebException(Throwable cause, javax.ws.rs.core.Response.Status status) Use WebException.wrap() and not the constructor.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause()
String	getHelpUrl()
String	getMessage()
String	getRequestId()
int	getReturnCode() Deprecated.
String	getStackTraceString()
int	getStatus()
static int	getStatus(Throwable cause) Tries to find the best matching HTTP status for the given exception.
static int	getStatus(Throwable cause, int depth)
int	getStatusCode()
String	getType()
static Object	handleError(javax.ws.rs.WebApplicationException e)
static boolean	isSecurityError(Throwable t)
static WebException	newException(String message, Throwable cause)
static WebException	newException(String message, Throwable cause, int status)
static WebException	newException(Throwable cause)
void	setStatus(int status)
javax.ws.rs.core.Response	toResponse() Handle if needed custom error webengine module handler.
static javax.ws.rs.core.Response	toResponse(Throwable t) Deprecated.
static String	toString(Throwable t)
protected javax.ws.rs.core.Response	toWebModuleResponse(WebContext ctx) Ask Webengine module for custom error handling and response.
static WebException	wrap(String message, Throwable exception)
static WebException	wrap(Throwable e)

Methods inherited from class javax.ws.rs.WebApplicationException

getResponse

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, 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

log

protected static final org.apache.commons.logging.Log log

type

protected String type

cause

protected Throwable cause

message

protected String message

status

protected int status

Constructor Detail

WebException

public WebException()

WebException

public WebException(javax.ws.rs.core.Response response)

WebException

public WebException(int status)

WebException

public WebException(javax.ws.rs.core.Response.Status status)

WebException

protected WebException(Throwable cause,
                       javax.ws.rs.core.Response.Status status)

Use WebException.wrap() and not the constructor.

WebException

protected WebException(Throwable cause,
                       int status)

WebException

protected WebException(Throwable cause)

WebException

public WebException(String message)

WebException

public WebException(String message,
                    int code)

WebException

public WebException(String message,
                    Throwable cause,
                    int status)

WebException

public WebException(String message,
                    Throwable cause)

Method Detail

newException

public static WebException newException(String message,
                                        Throwable cause)

newException

public static WebException newException(Throwable cause)

newException

public static WebException newException(String message,
                                        Throwable cause,
                                        int status)

toString

public static String toString(Throwable t)

wrap

public static WebException wrap(Throwable e)

wrap

public static WebException wrap(String message,
                                Throwable exception)

handleError

public static Object handleError(javax.ws.rs.WebApplicationException e)

getStatus

public static int getStatus(Throwable cause)

Tries to find the best matching HTTP status for the given exception.

getStatus

public static int getStatus(Throwable cause,
                            int depth)

isSecurityError

public static boolean isSecurityError(Throwable t)

toResponse

@Deprecated
public static javax.ws.rs.core.Response toResponse(Throwable t)

Deprecated.

For compatibility only.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getStatusCode

public int getStatusCode()

getStackTraceString

public String getStackTraceString()

getReturnCode

@Deprecated
public int getReturnCode()

Deprecated.

For compatibility only.

toResponse

public javax.ws.rs.core.Response toResponse()

Handle if needed custom error webengine module handler.

toWebModuleResponse

protected javax.ws.rs.core.Response toWebModuleResponse(WebContext ctx)

Ask Webengine module for custom error handling and response.

getStatus

public int getStatus()

setStatus

public void setStatus(int status)

getType

public String getType()

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable

getRequestId

public String getRequestId()

getHelpUrl

public String getHelpUrl()