QGIS API Documentation  3.17.0-Master (df2c9ff931)
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
[legend]

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
 Formats 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.

Since
QGIS 3.0

Definition at line 82 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" ) 
)

Construction.

Definition at line 43 of file qgsserverexception.cpp.

Member Function Documentation

◆ code()

QString QgsOgcServiceException::code ( ) const
inline

Returns the exception code.

Definition at line 97 of file qgsserverexception.h.

◆ formatResponse()

QByteArray QgsOgcServiceException::formatResponse ( QString &  responseFormat) const
overridevirtual

Formats the exception for sending to client.

Parameters
responseFormatQString to store the content type of the response format.
Returns
QByteArray The formatted response.

The default implementation returns text/xml format.

Reimplemented from QgsServerException.

Definition at line 54 of file qgsserverexception.cpp.

◆ locator()

QString QgsOgcServiceException::locator ( ) const
inline

Returns the locator.

Definition at line 100 of file qgsserverexception.h.

◆ message()

QString QgsOgcServiceException::message ( ) const
inline

Returns the exception message.

Definition at line 94 of file qgsserverexception.h.

◆ version()

QString QgsOgcServiceException::version ( ) const
inline

Returns the exception version.

Definition at line 103 of file qgsserverexception.h.


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