QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | List of all members
QgsWms::QgsSecurityException Class Reference

Exception thrown when data access violates access controls. More...

#include <qgswmsserviceexception.h>

Inheritance diagram for QgsWms::QgsSecurityException:
Inheritance graph
[legend]

Public Member Functions

 QgsSecurityException (const QString &message, const QString &locator=QString())
 Constructor for QgsSecurityException (HTTP error code 403 with Security code name). More...
 
- Public Member Functions inherited from QgsWms::QgsServiceException
 QgsServiceException (const QString &code, const QString &message, const QString &locator=QString(), int responseCode=200)
 Constructor for QgsServiceException. More...
 
 QgsServiceException (const QString &code, const QString &message, int responseCode)
 Constructor for QgsServiceException (empty locator attribute). More...
 
 QgsServiceException (ExceptionCode code, const QgsWmsParameter &parameter, int responseCode)
 Constructor for QgsServiceException (empty locator attribute). More...
 
 QgsServiceException (ExceptionCode code, const QString &message, int responseCode)
 Constructor for QgsServiceException (empty locator attribute). More...
 
- Public Member Functions inherited from QgsOgcServiceException
 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...
 
virtual QByteArray formatResponse (QString &responseFormat) const
 Formats the exception for sending to client. 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 ()
 

Additional Inherited Members

- Public Types inherited from QgsWms::QgsServiceException
enum  ExceptionCode {
  OGC_InvalidFormat , OGC_InvalidSRS , OGC_LayerNotDefined , OGC_StyleNotDefined ,
  OGC_LayerNotQueryable , OGC_CurrentUpdateSequence , OGC_InvalidUpdateSequence , OGC_MissingDimensionValue ,
  OGC_InvalidDimensionValue , OGC_InvalidPoint , OGC_InvalidCRS , OGC_OperationNotSupported ,
  QGIS_MissingParameterValue , QGIS_InvalidParameterValue
}
 Exception codes as defined in OGC scpecifications for WMS 1.1.1 and WMS 1.3.0. More...
 

Detailed Description

Exception thrown when data access violates access controls.

Since
QGIS 3.0

Definition at line 192 of file qgswmsserviceexception.h.

Constructor & Destructor Documentation

◆ QgsSecurityException()

QgsWms::QgsSecurityException::QgsSecurityException ( const QString &  message,
const QString &  locator = QString() 
)
inline

Constructor for QgsSecurityException (HTTP error code 403 with Security code name).

Parameters
messageException message to return to the client
locatorLocator attribute according to OGC specifications

Definition at line 202 of file qgswmsserviceexception.h.


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