QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
server
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
21
#include <QString>
22
23
class
QgsServerResponse
;
24
class
QgsServerRequest
;
25
class
QgsServerInterface
;
26
class
QgsProject
;
27
40
class
SERVER_EXPORT
QgsServerApiContext
41
{
42
public
:
53
QgsServerApiContext
(
const
QString &
apiRootPath
,
const
QgsServerRequest
*
request
,
QgsServerResponse
*
response
,
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
QString mApiRootPath;
114
const
QgsServerRequest
*mRequest =
nullptr
;
115
QgsServerResponse
*mResponse =
nullptr
;
116
const
QgsProject
*mProject =
nullptr
;
117
QgsServerInterface
*mServerInterface =
nullptr
;
118
};
119
120
#endif
// QGSSERVERAPICONTEXT_H
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:114
QgsServerApiContext::project
const QgsProject * project() const
Returns the (possibly NULL) project.
Definition
qgsserverapicontext.cpp:43
QgsServerApiContext::response
QgsServerResponse * response() const
Returns the server response object.
Definition
qgsserverapicontext.cpp:37
QgsServerApiContext::handlerPath
QString handlerPath() const
Returns the handler component of the URL path, i.e.
Definition
qgsserverapicontext.cpp:83
QgsServerApiContext::request
const QgsServerRequest * request() const
Returns the server request object.
Definition
qgsserverapicontext.cpp:31
QgsServerApiContext::setProject
void setProject(const QgsProject *project)
Sets the project to project.
Definition
qgsserverapicontext.cpp:48
QgsServerApiContext::setRequest
void setRequest(const QgsServerRequest *request)
Sets context request to request.
Definition
qgsserverapicontext.cpp:78
QgsServerApiContext::serverInterface
QgsServerInterface * serverInterface() const
Returns the server interface.
Definition
qgsserverapicontext.cpp:53
QgsServerApiContext::apiRootPath
QString apiRootPath() const
Returns the API root path.
Definition
qgsserverapicontext.cpp:73
QgsServerApiContext::QgsServerApiContext
QgsServerApiContext(const QString &apiRootPath, const QgsServerRequest *request, QgsServerResponse *response, const QgsProject *project, QgsServerInterface *serverInterface)
QgsServerApiContext constructor.
Definition
qgsserverapicontext.cpp:23
QgsServerApiContext::matchedPath
const QString matchedPath() const
Returns the initial part of the incoming request URL path that matches the API root path.
Definition
qgsserverapicontext.cpp:58
QgsServerInterface
Defines interfaces exposed by QGIS Server and made available to plugins.
Definition
qgsserverinterface.h:61
QgsServerRequest
Defines requests passed to QgsService classes.
Definition
qgsserverrequest.h:36
QgsServerResponse
Defines the response interface passed to QgsService.
Definition
qgsserverresponse.h:42
Generated on
for QGIS API Documentation by
1.17.0