com.luciad.ogc.common

OGC ServerClass TLcdOGCServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.luciad.ogc.common.TLcdOGCServiceException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TLcdCSWServiceException, TLcdWCSServiceException, TLcdWFSServiceException

public class TLcdOGCServiceException
extends java.lang.Exception

Base class for OGC service exceptions.

This class can hold multiple TLcdOWSException instances, that each represent a subset or part of this service exception.

At least one TLcdOWSException is required, initialized through one of the constructors. Additional exceptions can be added through addException(com.luciad.ogc.ows.model.TLcdOWSException) and addException(String, int, String). The list of exceptions can be retrieved through getExceptions().

See Also:

TLcdOWSException, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHENTICATION_REQUIRED The user needs to be authenticated to access a resource.
static java.lang.String	AUTHENTICATION_REQUIRED_STR The user needs to be authenticated to access a resource.
static int	CONFIG_ERROR
static java.lang.String	CONFIG_ERROR_STR
static int	INVALID_REQUEST
static java.lang.String	INVALID_REQUEST_STR
static int	NOT_AUTHORIZED The user is not authorized to access a resource.
static java.lang.String	NOT_AUTHORIZED_STR The user is not authorized to access a resource.
static int	REQUEST_XML_ERROR
static java.lang.String	REQUEST_XML_ERROR_STR
static int	UNKNOWN_REQUEST
static java.lang.String	UNKNOWN_REQUEST_STR

Constructor Summary

Constructors

Constructor and Description
TLcdOGCServiceException(int aCode) Constructor with an error code.
TLcdOGCServiceException(java.lang.String aMessage, int aCode) Constructor with an error message and code.
TLcdOGCServiceException(java.lang.String aMessage, int aCode, java.lang.String aLocator) Constructor with an error message, code and locator.
TLcdOGCServiceException(java.lang.String aMessage, int aCode, java.lang.String aLocator, java.lang.String aServiceVersion, java.lang.String aServiceName) Constructor with an error message, code, locator and service information.
TLcdOGCServiceException(TLcdOWSException aException, java.lang.String aServiceVersion, java.lang.String aServiceName) Constructor with an OWS exception.

Method Summary

Modifier and Type	Method and Description
void	addException(java.lang.String aMessage, int aCode, java.lang.String aLocator) Adds an exception with the given message, code and locator.
void	addException(TLcdOWSException aException) Adds the given OWS exception.
int	getCode() Returns the error code of the first exception.
java.lang.String	getCodeAsAString(int aCode) Returns a string describing the given error code.
java.util.List<TLcdOWSException>	getExceptions() Returns a list of exceptions.
java.lang.String	getLocator() Returns the locator of the first exception, if initialized.
java.lang.String	getMessage() Returns the error message of the first exception, if initialized.
java.lang.String	getMimeType() Returns the MIME type to be set when sending exception reports to a client.
java.lang.String	getServiceName() Returns the service name generated this exception.
java.lang.String	getServiceVersion() Returns the version of the service that generated this 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

UNKNOWN_REQUEST

public static final int UNKNOWN_REQUEST

See Also:

Constant Field Values

REQUEST_XML_ERROR

public static final int REQUEST_XML_ERROR

See Also:

Constant Field Values

INVALID_REQUEST

public static final int INVALID_REQUEST

See Also:

Constant Field Values

CONFIG_ERROR

public static final int CONFIG_ERROR

See Also:

Constant Field Values

NOT_AUTHORIZED

public static final int NOT_AUTHORIZED

The user is not authorized to access a resource.

Since:

2017.0

See Also:

Constant Field Values

AUTHENTICATION_REQUIRED

public static final int AUTHENTICATION_REQUIRED

The user needs to be authenticated to access a resource.

Since:

2017.0

See Also:

Constant Field Values

UNKNOWN_REQUEST_STR

public static final java.lang.String UNKNOWN_REQUEST_STR

See Also:

Constant Field Values

REQUEST_XML_ERROR_STR

public static final java.lang.String REQUEST_XML_ERROR_STR

See Also:

Constant Field Values

INVALID_REQUEST_STR

public static final java.lang.String INVALID_REQUEST_STR

See Also:

Constant Field Values

CONFIG_ERROR_STR

public static final java.lang.String CONFIG_ERROR_STR

See Also:

Constant Field Values

NOT_AUTHORIZED_STR

public static final java.lang.String NOT_AUTHORIZED_STR

The user is not authorized to access a resource.

Since:

2017.0

See Also:

Constant Field Values

AUTHENTICATION_REQUIRED_STR

public static final java.lang.String AUTHENTICATION_REQUIRED_STR

The user needs to be authenticated to access a resource.

Since:

2017.0

See Also:

Constant Field Values

Constructor Detail

TLcdOGCServiceException

public TLcdOGCServiceException(int aCode)

Constructor with an error code.

The given exception information is converted to a TLcdOWSException and added to the list of exceptions. This list can be retrieved through getExceptions().

Parameters:

aCode - the exception's error code.

TLcdOGCServiceException

public TLcdOGCServiceException(java.lang.String aMessage,
                               int aCode)

Constructor with an error message and code.

The given exception information is converted to a TLcdOWSException and added to the list of exceptions. This list can be retrieved through getExceptions().

Parameters:

aMessage - the error message

aCode - the exception's error code.

TLcdOGCServiceException

public TLcdOGCServiceException(java.lang.String aMessage,
                               int aCode,
                               java.lang.String aLocator)

Constructor with an error message, code and locator.

The given exception information is converted to a TLcdOWSException and added to the list of exceptions. This list can be retrieved through getExceptions().

Parameters:

aMessage - the error message

aCode - the exception's error code.

aLocator - the location of the error in the client request

TLcdOGCServiceException

public TLcdOGCServiceException(java.lang.String aMessage,
                               int aCode,
                               java.lang.String aLocator,
                               java.lang.String aServiceVersion,
                               java.lang.String aServiceName)

Constructor with an error message, code, locator and service information.

The given exception information is converted to a TLcdOWSException and added to the list of exceptions. This list can be retrieved through getExceptions().

Parameters:

aMessage - the error message

aCode - the exception's error code.

aLocator - the location of the error in the client request

aServiceVersion - the version of the service that generated the exception.

aServiceName - the name of the service that generated the exception.

TLcdOGCServiceException

public TLcdOGCServiceException(TLcdOWSException aException,
                               java.lang.String aServiceVersion,
                               java.lang.String aServiceName)

Constructor with an OWS exception.

Parameters:

aException - an OWS exception.

aServiceVersion - the version of the service that generated the exception.

aServiceName - the name of the service that generated the exception.

Method Detail

addException

public void addException(java.lang.String aMessage,
                         int aCode,
                         java.lang.String aLocator)

Adds an exception with the given message, code and locator.

This exception is converted to a TLcdOWSException, and can be retrieved through getExceptions().

Parameters:

aMessage - the optional error message.

aCode - the mandatory exception's error code.

aLocator - the location of the error in the client request, or null if this information is not available.

addException

public void addException(TLcdOWSException aException)

Adds the given OWS exception.

Parameters:

aException - the exception to be added.

getExceptions

public java.util.List<TLcdOWSException> getExceptions()

Returns a list of exceptions.

Returns:

a list of exceptions.

getMessage

public java.lang.String getMessage()

Returns the error message of the first exception, if initialized.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the error message of the first exception, if initialized; null otherwise.

getCode

public int getCode()

Returns the error code of the first exception.

Returns:

the exception's error code.

getLocator

public java.lang.String getLocator()

Returns the locator of the first exception, if initialized.

Returns:

the locator of the first exception, if initialized; null otherwise.

getServiceName

public java.lang.String getServiceName()

Returns the service name generated this exception.

Returns:

the service name generated this exception, or null if no service name is available.

getServiceVersion

public java.lang.String getServiceVersion()

Returns the version of the service that generated this exception.

Returns:

the version of the service that generated this exception, or null if no version information is available.

getCodeAsAString

public java.lang.String getCodeAsAString(int aCode)

Returns a string describing the given error code.

Parameters:

aCode - the exception's error code

Returns:

a string describing the given error code.

getMimeType

public java.lang.String getMimeType()

Returns the MIME type to be set when sending exception reports to a client.

Returns:

the MIME type to be set when sending exception reports to a client.