1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverapicontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerApiContext
{
%Docstring(signature="appended")
The :py:class:`QgsServerApiContext` class encapsulates the resources for
a particular client request: the request and response objects, the
project (might be NULL) and the server interface, the API root path that
matched the request is also added.
:py:class:`QgsServerApiContext` is lightweight copyable object meant to
be passed along the request handlers chain.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsserverapicontext.h"
%End
public:
QgsServerApiContext( const QString &apiRootPath, const QgsServerRequest *request, QgsServerResponse *response, const QgsProject *project, QgsServerInterface *serverInterface );
%Docstring
QgsServerApiContext constructor
:param apiRootPath: is the API root path, this information is used by
the handlers to build the href links to the
resources and to the HTML templates.
:param request: the incoming request
:param response: the response
:param project: the project (might be NULL)
:param serverInterface: the server interface
%End
const QgsServerRequest *request() const;
%Docstring
Returns the server request object
%End
QgsServerResponse *response() const;
%Docstring
Returns the server response object
%End
const QgsProject *project() const;
%Docstring
Returns the (possibly NULL) project
.. seealso:: :py:func:`setProject`
%End
void setProject( const QgsProject *project );
%Docstring
Sets the project to ``project``
.. seealso:: :py:func:`project`
%End
QgsServerInterface *serverInterface() const;
%Docstring
Returns the server interface
%End
const QString matchedPath() const;
%Docstring
Returns the initial part of the incoming request URL path that matches
the API root path. If there is no match returns an empty string (it
should never happen).
I.e. for an API with root path "/wfs3" and an incoming request
"https://www.qgis.org/services/wfs3/collections" this method will return
"/resources/wfs3"
%End
QString apiRootPath() const;
%Docstring
Returns the API root path
%End
void setRequest( const QgsServerRequest *request );
%Docstring
Sets context request to ``request``
%End
QString handlerPath() const;
%Docstring
Returns the handler component of the URL path, i.e. the part of the path
that comes after the API path.
.. versionadded:: 3.22
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverapicontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
