uws

Class UWSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

uws.UWSException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UnsupportedURIProtocolException

public class UWSException
extends java.lang.Exception

Any exception returned by a class of the UWS pattern may be associated with an HTTP error code (like: 404, 303, 500) and a UWS error type.

Any error reported with this kind of exception will (in the most of cases) interrupt a UWS action, by reporting an error related with the UWS usage.

Version:

4.1 (09/2014)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPTED_BUT_NOT_COMPLETE
static int	BAD_REQUEST
protected ErrorType	errorType The UWS error type (by default FATAL).
static int	FORBIDDEN
protected int	httpErrorCode The HTTP error code (by default NOT_FOUND).
static int	INTERNAL_SERVER_ERROR
static int	NO_CONTENT
static int	NOT_ALLOWED
static int	NOT_FOUND
static int	NOT_IMPLEMENTED
static int	OK
static int	PERMISSION_DENIED
static int	REQUEST_ENTITY_TOO_LARGE
static int	SEE_OTHER
static int	SERVICE_UNAVAILABLE
static int	USER_ACCESS_DENIED

Constructor Summary

Constructors

Constructor and Description
UWSException(int httpError, java.lang.String msg) Exception that occurs in the general context of UWS and which should return the given HTTP error code.
UWSException(int httpError, java.lang.String msg, ErrorType type) Exception that occurs in the general context of UWS, with the given type and which should return the given HTTP error code.
UWSException(int httpError, java.lang.Throwable t) Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.
UWSException(int httpError, java.lang.Throwable t, ErrorType type) Exception that occurs in the general context of UWS with the given error type, because the given exception has been thrown and that which should return the given HTTP error status.
UWSException(int httpError, java.lang.Throwable t, java.lang.String msg) Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.
UWSException(int httpError, java.lang.Throwable t, java.lang.String msg, ErrorType type) Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.
UWSException(java.lang.String msg) Exception in the general context of UWS.
UWSException(java.lang.String msg, ErrorType type) Exception that occurs in the general context of UWS, and with the specified error type (FATAL or TRANSIENT).
UWSException(java.lang.Throwable t) Exception that occurs in the general context of UWS because the given exception has been thrown.
UWSException(java.lang.Throwable t, ErrorType type) Exception with the given type that occurs in the general context of UWS because the given exception has been thrown.

Method Summary

Modifier and Type	Method and Description
int	getHttpErrorCode() Get the HTTP error code that should be returned.
ErrorType	getUWSErrorType() Get the type of this error (from the UWS point of view ; FATAL or TRANSIENT).

Methods inherited from class java.lang.Throwable

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

OK

public static final int OK

See Also:

Constant Field Values

ACCEPTED_BUT_NOT_COMPLETE

public static final int ACCEPTED_BUT_NOT_COMPLETE

See Also:

Constant Field Values

NO_CONTENT

public static final int NO_CONTENT

See Also:

Constant Field Values

SEE_OTHER

public static final int SEE_OTHER

See Also:

Constant Field Values

BAD_REQUEST

public static final int BAD_REQUEST

See Also:

Constant Field Values

FORBIDDEN

public static final int FORBIDDEN

See Also:

Constant Field Values

NOT_FOUND

public static final int NOT_FOUND

See Also:

Constant Field Values

NOT_ALLOWED

public static final int NOT_ALLOWED

See Also:

Constant Field Values

REQUEST_ENTITY_TOO_LARGE

public static final int REQUEST_ENTITY_TOO_LARGE

See Also:

Constant Field Values

INTERNAL_SERVER_ERROR

public static final int INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

NOT_IMPLEMENTED

public static final int NOT_IMPLEMENTED

See Also:

Constant Field Values

SERVICE_UNAVAILABLE

public static final int SERVICE_UNAVAILABLE

See Also:

Constant Field Values

USER_ACCESS_DENIED

public static final int USER_ACCESS_DENIED

See Also:

Constant Field Values

PERMISSION_DENIED

public static final int PERMISSION_DENIED

See Also:

Constant Field Values

httpErrorCode

protected int httpErrorCode

The HTTP error code (by default NOT_FOUND). It MUST BE greater than 0.

errorType

protected ErrorType errorType

The UWS error type (by default FATAL). It MUST BE non null.

Constructor Detail

UWSException

public UWSException(java.lang.String msg)

Exception in the general context of UWS.

Parameters:

msg - Error message to display.

UWSException

public UWSException(java.lang.String msg,
                    ErrorType type)

Exception that occurs in the general context of UWS, and with the specified error type (FATAL or TRANSIENT).

Parameters:

msg - Error message to display.

type - Type of the error (FATAL or TRANSIENT). Note: If NULL, it will be considered as FATAL.

UWSException

public UWSException(java.lang.Throwable t)

Exception that occurs in the general context of UWS because the given exception has been thrown.

Parameters:

t - The thrown (and so caught) exception.

UWSException

public UWSException(java.lang.Throwable t,
                    ErrorType type)

Exception with the given type that occurs in the general context of UWS because the given exception has been thrown.

Parameters:

t - The thrown (and so caught) exception.

type - Type of the error (FATAL or TRANSIENT). Note: If NULL, it will be considered as FATAL.

UWSException

public UWSException(int httpError,
                    java.lang.String msg)

Exception that occurs in the general context of UWS and which should return the given HTTP error code.

Parameters:

httpError - HTTP error code to return.

msg - Error message to display.

UWSException

public UWSException(int httpError,
                    java.lang.String msg,
                    ErrorType type)

Exception that occurs in the general context of UWS, with the given type and which should return the given HTTP error code.

Parameters:

httpError - HTTP error code to return.

msg - Error message to display.

type - Type of the error (FATAL or TRANSIENT). Note: If NULL, it will be considered as FATAL.

UWSException

public UWSException(int httpError,
                    java.lang.Throwable t)

Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.

Parameters:

httpError - HTTP error code to return.

t - The thrown (and so caught) exception.

UWSException

public UWSException(int httpError,
                    java.lang.Throwable t,
                    ErrorType type)

Exception that occurs in the general context of UWS with the given error type, because the given exception has been thrown and that which should return the given HTTP error status.

Parameters:

httpError - HTTP error code to return.

t - The thrown (and so caught) exception.

type - Type of the error (FATAL or TRANSIENT). Note: If NULL, it will be considered as FATAL.

UWSException

public UWSException(int httpError,
                    java.lang.Throwable t,
                    java.lang.String msg)

Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.

Parameters:

httpError - HTTP error code to return.

t - The thrown (and so caught) exception.

msg - Error message to display.

UWSException

public UWSException(int httpError,
                    java.lang.Throwable t,
                    java.lang.String msg,
                    ErrorType type)

Exception that occurs in the general context of UWS, because the given exception has been thrown and that which should return the given HTTP error status.

Parameters:

httpError - HTTP error code to return.

t - The thrown (and so caught) exception.

msg - Error message to display.

type - Type of the error (FATAL or TRANSIENT). Note: If NULL, it will be considered as FATAL.

Method Detail

getHttpErrorCode

public int getHttpErrorCode()

Get the HTTP error code that should be returned.

Returns:

The corresponding HTTP error code.

getUWSErrorType

public ErrorType getUWSErrorType()

Get the type of this error (from the UWS point of view ; FATAL or TRANSIENT).

Returns:

Type of this error.