QGIS API Documentation 3.27.0-Master (95e00c50d2)
qgsserverapicontext.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsserverapicontext.h - QgsServerApiContext
3
4 ---------------------
5 begin : 13.5.2019
6 copyright : (C) 2019 by Alessandro Pasotti
7 email : elpaso at itopen dot it
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16#ifndef QGSSERVERAPICONTEXT_H
17#define QGSSERVERAPICONTEXT_H
18
19#include "qgis_server.h"
20#include <QString>
21
25class QgsProject;
26
38class SERVER_EXPORT QgsServerApiContext
39{
40 public:
41
52 QgsServerApiContext( const QString &apiRootPath, const QgsServerRequest *request, QgsServerResponse *response,
53 const QgsProject *project, QgsServerInterface *serverInterface );
54
58 const QgsServerRequest *request() const;
59
63 QgsServerResponse *response() const;
64
69 const QgsProject *project() const;
70
75 void setProject( const QgsProject *project );
76
80 QgsServerInterface *serverInterface() const;
81
92 const QString matchedPath( ) const;
93
97 QString apiRootPath() const;
98
102 void setRequest( const QgsServerRequest *request );
103
110 QString handlerPath( ) const;
111
112 private:
113
114 QString mApiRootPath;
115 const QgsServerRequest *mRequest = nullptr;
116 QgsServerResponse *mResponse = nullptr;
117 const QgsProject *mProject = nullptr;
118 QgsServerInterface *mServerInterface = nullptr;
119};
120
121#endif // QGSSERVERAPICONTEXT_H
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:104
The QgsServerApiContext class encapsulates the resources for a particular client request: the request...
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
QgsServerRequest Class defining request interface passed to services QgsService::executeRequest() met...
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...