QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsOgcServiceException Class Reference

Exception base class for service exceptions. More...

#include <qgsserverexception.h>

Inheritance diagram for QgsOgcServiceException:
Inheritance graph

Public Member Functions

 QgsOgcServiceException (const QString &code, const QString &message, const QString &locator=QString(), int responseCode=200, const QString &version=QStringLiteral("1.3.0"))
 Construction. More...
QString code () const
 Returns the exception code. More...
QByteArray formatResponse (QString &responseFormat) const override
 Format the exception for sending to client. More...
QString locator () const
 Returns the locator. More...
QString message () const
 Returns the exception message. More...
QString version () const
 Returns the exception version. More...
- Public Member Functions inherited from QgsServerException
 QgsServerException (const QString &message, int responseCode=500)
 Constructor. More...
int responseCode () const
- Public Member Functions inherited from QgsException
 QgsException (const QString &message)
 Constructor for QgsException, with the specified error message. More...
virtual ~QgsException ()=default throw ()
QString what () const throw ()

Detailed Description

Exception base class for service exceptions.

Note that this exception is associated with a default return code 200 which may be not appropriate in some situations.

QGIS 3.0

Definition at line 77 of file qgsserverexception.h.

Constructor & Destructor Documentation

◆ QgsOgcServiceException()

QgsOgcServiceException::QgsOgcServiceException ( const QString &  code,
const QString &  message,
const QString &  locator = QString(),
int  responseCode = 200,
const QString &  version = QStringLiteral("1.3.0") 


Member Function Documentation

◆ code()

QString QgsOgcServiceException::code ( ) const

Returns the exception code.

Definition at line 92 of file qgsserverexception.h.

◆ formatResponse()

QByteArray QgsOgcServiceException::formatResponse ( QString &  responseFormat) const

Format the exception for sending to client.

responseFormatQString to store the content type of the response format.
QByteArray the fermatted response.

The defaolt implementation return text/xml format.

Reimplemented from QgsServerException.

◆ locator()

QString QgsOgcServiceException::locator ( ) const

Returns the locator.

Definition at line 95 of file qgsserverexception.h.

◆ message()

QString QgsOgcServiceException::message ( ) const

Returns the exception message.

Definition at line 89 of file qgsserverexception.h.

◆ version()

QString QgsOgcServiceException::version ( ) const

Returns the exception version.

Definition at line 98 of file qgsserverexception.h.

The documentation for this class was generated from the following file: