qgsservice.h

Go to the documentation of this file.

/***************************************************************************
                          qgsservice.h

  Class defining the service interface for QGIS server services.
  -------------------
  begin                : 2016-12-05
  copyright            : (C) 2016 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 QGSSERVICECOMPONENT_H
#define QGSSERVICECOMPONENT_H

#include "qgsserverrequest.h"
#include "qgsserverresponse.h"

class QgsProject;

class SERVER_EXPORT QgsService
{
#ifdef SIP_RUN
#include "qgsserverrequest.h"
#include "qgsserverresponse.h"
#endif

  public:

    QgsService();

    virtual ~QgsService() = default;

    virtual QString name() const = 0;

    virtual QString version() const = 0;

    virtual bool allowMethod( QgsServerRequest::Method ) const = 0;

    virtual void executeRequest( const QgsServerRequest &request,
                                 QgsServerResponse &response,
                                 const QgsProject *project ) = 0;
};

#endif