qgsserverapi.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserverapi.h

  Class defining the service interface for QGIS server APIs.
  -------------------
  begin                : 2019-04-16
  copyright            : (C) 2019 by Alessandro Pasotti
  email                : elpaso at itopen dot it
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSSERVERAPI_H
#define QGSSERVERAPI_H

#include "qgis_server.h"
#include <QRegularExpression>
#include "qgsserverexception.h"
#include "qgsserverrequest.h"

class QgsServerResponse;
class QgsProject;
class QgsServerApiContext;
class QgsServerInterface;

class SERVER_EXPORT QgsServerApi
{

  public:

    QgsServerApi( QgsServerInterface *serverIface );

    virtual ~QgsServerApi() = default;

    virtual const QString name() const = 0;

    virtual const QString description() const = 0;

    virtual const QString version() const { return QString(); }

    virtual const QString rootPath() const = 0;

    virtual bool allowMethod( QgsServerRequest::Method ) const { return true; }

    virtual bool accept( const QUrl &url ) const;

    virtual void executeRequest( const QgsServerApiContext &context ) const = 0;

    QgsServerInterface *serverIface() const;

  private:

    QgsServerInterface *mServerIface = nullptr;
};


#endif // QGSSERVERAPI_H