qgsserverexception.h

Go to the documentation of this file.

/***************************************************************************
                              qgserverexception.h
                              ------------------------
  begin                : January 11, 2017
  copyright            : (C) 2017 by David Marteau
  email                : david dot marteau at 3liz dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSERVEREXCEPTION_H
#define QGSSERVEREXCEPTION_H
 
 
#include <nlohmann/json.hpp>
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsexception.h"
 
#include <QByteArray>
#include <QString>
 
#ifndef SIP_RUN
using namespace Qt::StringLiterals;
using namespace nlohmann;
#endif
 

#ifndef SIP_RUN
class SERVER_EXPORT QgsServerException : public QgsException
{
#else
class SERVER_EXPORT QgsServerException
{
#endif
  public:
    QgsServerException( const QString &message, int responseCode = 500 );

    int responseCode() const { return mResponseCode; }

    virtual QByteArray formatResponse( QString &responseFormat SIP_OUT ) const;
 
  private:
    int mResponseCode;
};

#ifndef SIP_RUN
class SERVER_EXPORT QgsOgcServiceException : public QgsServerException
{
#else
class SERVER_EXPORT QgsOgcServiceException
{
#endif
  public:
    QgsOgcServiceException( const QString &code, const QString &message, const QString &locator = QString(), int responseCode = 200, const QString &version = u"1.3.0"_s );

    QString message() const { return mMessage; }

    QString code() const { return mCode; }

    QString locator() const { return mLocator; }

    QString version() const { return mVersion; }
 
    QByteArray formatResponse( QString &responseFormat SIP_OUT ) const override;
 
  private:
    QString mCode;
    QString mMessage;
    QString mLocator;
    QString mVersion;
};

#ifndef SIP_RUN
class SERVER_EXPORT QgsBadRequestException : public QgsOgcServiceException
{
  public:
    QgsBadRequestException( const QString &code, const QString &message, const QString &locator = QString() )
      : QgsOgcServiceException( code, message, locator, 400 )
    {}
};
#endif
 
#ifndef SIP_RUN // No API exceptions for SIP, see python/server/qgsserverexception.sip

class SERVER_EXPORT QgsServerApiException : public QgsServerException
{
  public:
    QgsServerApiException( const QString &code, const QString &message, const QString &mimeType = u"application/json"_s, int responseCode = 200 )
      : QgsServerException( message, responseCode )
      , mCode( code )
      , mMimeType( mimeType )
    {}
 
    QByteArray formatResponse( QString &responseFormat SIP_OUT ) const override
    {
      responseFormat = mMimeType;
      const json data { {
        { "code", mCode.toStdString() },
        { "description", what().toStdString() },
      } };
 
      return QByteArray::fromStdString( data.dump() );
    }
 
  private:
    QString mCode;
    QString mMimeType;
};
 

class SERVER_EXPORT QgsServerApiInternalServerError : public QgsServerApiException
{
  public:
    QgsServerApiInternalServerError( const QString &message = u"Internal server error"_s, const QString &mimeType = u"application/json"_s, int responseCode = 500 )
      : QgsServerApiException( u"Internal server error"_s, message, mimeType, responseCode )
    {}
};
 

class SERVER_EXPORT QgsServerApiNotFoundError : public QgsServerApiException
{
  public:
    QgsServerApiNotFoundError( const QString &message, const QString &mimeType = u"application/json"_s, int responseCode = 404 )
      : QgsServerApiException( u"API not found error"_s, message, mimeType, responseCode )
    {}
};
 

class SERVER_EXPORT QgsServerApiBadRequestException : public QgsServerApiException
{
  public:
    QgsServerApiBadRequestException( const QString &message, const QString &mimeType = u"application/json"_s, int responseCode = 400 )
      : QgsServerApiException( u"Bad request error"_s, message, mimeType, responseCode )
    {}
};
 

class SERVER_EXPORT QgsServerApiPermissionDeniedException : public QgsServerApiException
{
  public:
    QgsServerApiPermissionDeniedException( const QString &message, const QString &mimeType = u"application/json"_s, int responseCode = 403 )
      : QgsServerApiException( u"Forbidden"_s, message, mimeType, responseCode )
    {}
};

class SERVER_EXPORT QgsServerApiImproperlyConfiguredException : public QgsServerApiException
{
  public:
    QgsServerApiImproperlyConfiguredException( const QString &message, const QString &mimeType = u"application/json"_s, int responseCode = 500 )
      : QgsServerApiException( u"Improperly configured error"_s, message, mimeType, responseCode )
    {}
};
 

class SERVER_EXPORT QgsServerApiNotImplementedException : public QgsServerApiException
{
  public:
    QgsServerApiNotImplementedException( const QString &message = u"Requested method is not implemented"_s, const QString &mimeType = u"application/json"_s, int responseCode = 500 )
      : QgsServerApiException( u"Not implemented error"_s, message, mimeType, responseCode )
    {}
};
 

class SERVER_EXPORT QgsServerApiInvalidMimeTypeException : public QgsServerApiException
{
  public:
    QgsServerApiInvalidMimeTypeException(
      const QString &message = u"The Accept header submitted in the request did not support any of the media types supported by the server for the requested resource"_s,
      const QString &mimeType = u"application/json"_s,
      int responseCode = 406
    )
      : QgsServerApiException( u"Invalid mime-type"_s, message, mimeType, responseCode )
    {}
};
#endif // no API exceptions for SIP
 
#endif