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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerInterface
{
%Docstring(signature="appended")
:py:class:`QgsServerInterface` Class defining interfaces exposed by QGIS
Server and made available to plugins.
This class provides methods to access the request handler and the
capabilities cache. A method to read the environment variables set in
the main FCGI loop is also available. Plugins can add listeners
(instances of :py:class:`QgsServerFilter`) with a certain priority
through the :py:func:`~registerFilter` method.
%End
%TypeHeaderCode
#include "qgsserverinterface.h"
%End
public:
virtual ~QgsServerInterface();
virtual QgsCapabilitiesCache *capabilitiesCache() = 0 /KeepReference/;
%Docstring
Gets pointer to the capabiblities cache
:return: :py:class:`QgsCapabilitiesCache`
%End
virtual QgsRequestHandler *requestHandler() = 0 /KeepReference/;
%Docstring
Gets pointer to the request handler
:return: :py:class:`QgsRequestHandler`
%End
virtual void registerFilter( QgsServerFilter *filter /Transfer/, int priority = 0 ) = 0;
%Docstring
Register a :py:class:`QgsServerFilter`
:param filter: the :py:class:`QgsServerFilter` to add
:param priority: an optional priority for the filter order
%End
virtual void setFilters( QgsServerFiltersMap *filters /Transfer/ ) = 0;
%Docstring
Set the filters map
:param filters: the :py:class:`QgsServerFiltersMap`
%End
virtual QgsServerFiltersMap filters() = 0;
%Docstring
Returns the list of current :py:class:`QgsServerFilter`
:return: :py:class:`QgsServerFiltersMap` list of
:py:class:`QgsServerFilter`
%End
virtual void registerAccessControl( QgsAccessControlFilter *accessControl /Transfer/, int priority = 0 ) = 0;
%Docstring
Register an access control filter
:param accessControl: the access control to register
:param priority: the priority used to order them
%End
virtual QgsAccessControl *accessControls() const = 0;
%Docstring
Gets the registered access control filters
%End
virtual void registerServerCache( QgsServerCacheFilter *serverCache /Transfer/, int priority = 0 ) = 0;
%Docstring
Register a server cache filter
:param serverCache: the server cache to register
:param priority: the priority used to order them
.. versionadded:: 3.4
%End
virtual QgsServerCacheManager *cacheManager() const = 0;
%Docstring
Gets the registered server cache filters
.. versionadded:: 3.4
%End
virtual QString getEnv( const QString &name ) const = 0;
%Docstring
Returns an enrironment variable, used to pass environment variables to
Python
%End
virtual QString configFilePath() = 0;
%Docstring
Returns the configuration file path
:return: QString containing the configuration file path
%End
virtual void setConfigFilePath( const QString &configFilePath ) = 0;
%Docstring
Set the configuration file path
:param configFilePath: QString with the configuration file path
%End
virtual void removeConfigCacheEntry( const QString &path ) = 0;
%Docstring
Remove entry from config cache
:param path: the path of the file to remove
%End
virtual QgsServiceRegistry *serviceRegistry() = 0 /KeepReference/;
%Docstring
Returns the service registry
:return: :py:class:`QgsServiceResgistry`
%End
virtual void reloadSettings() = 0;
%Docstring
Reloads the server settings re-reading the configuration.
.. versionadded:: 3.28
%End
private:
QgsServerInterface();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
