QgsOgcServiceException Class Reference

Exception base class for service exceptions. More...

#include <qgsserverexception.h>

Inheritance diagram for QgsOgcServiceException:

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.
QString	code () const
	Returns the exception code.
QByteArray	formatResponse (QString &responseFormat) const override
	Formats the exception for sending to client.
QString	locator () const
	Returns the locator.
QString	message () const
	Returns the exception message.
QString	version () const
	Returns the exception version.
Public Member Functions inherited from QgsServerException
	QgsServerException (const QString &message, int responseCode=500)
	Constructor.
int	responseCode () const
Public Member Functions inherited from QgsException
	QgsException (const QString &message)
	Constructor for QgsException, with the specified error message.
virtual	~QgsException () throw () =default
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.

Definition at line 80 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 46 of file qgsserverexception.cpp.

Member Function Documentation

code()

QString QgsOgcServiceException::code ( ) const

inline

Returns the exception code.

Definition at line 95 of file qgsserverexception.h.

formatResponse()

QByteArray QgsOgcServiceException::formatResponse ( QString &  responseFormat ) const

overridevirtual

Formats the exception for sending to client.

Parameters

responseFormat

QString 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 56 of file qgsserverexception.cpp.

locator()

QString QgsOgcServiceException::locator ( ) const

inline

Returns the locator.

Definition at line 98 of file qgsserverexception.h.

message()

QString QgsOgcServiceException::message ( ) const

inline

Returns the exception message.

Definition at line 92 of file qgsserverexception.h.

version()

QString QgsOgcServiceException::version ( ) const

inline

Returns the exception version.

Definition at line 101 of file qgsserverexception.h.

---

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

• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/server/qgsserverexception.h
• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/server/qgsserverexception.cpp