QGIS API Documentation 3.41.0-Master (3c143d501a8)
|
Interfaces exposed by QGIS Server and made available to plugins. More...
#include <qgsserverinterfaceimpl.h>
Public Member Functions | |
QgsServerInterfaceImpl (QgsCapabilitiesCache *capCache, QgsServiceRegistry *srvRegistry, QgsServerSettings *serverSettings) | |
Constructor. | |
~QgsServerInterfaceImpl () override | |
QgsAccessControl * | accessControls () const override |
Gets the helper over all the registered access control filters. | |
QgsServerCacheManager * | cacheManager () const override |
Gets the helper over all the registered server cache filters. | |
QgsCapabilitiesCache * | capabilitiesCache () override |
Gets pointer to the capabiblities cache. | |
void | clearRequestHandler () override |
Clear the request handler. | |
QString | configFilePath () override |
Returns the configuration file path. | |
QgsServerFiltersMap | filters () override |
Returns the list of current QgsServerFilter. | |
QString | getEnv (const QString &name) const override |
Returns an enrironment variable, used to pass environment variables to Python. | |
void | registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0) override |
Register an access control filter. | |
void | registerFilter (QgsServerFilter *filter, int priority=0) override |
Register a QgsServerFilter. | |
void | registerServerCache (QgsServerCacheFilter *serverCache, int priority=0) override |
Registers a server cache filter. | |
void | reloadSettings () override |
Reloads the server settings re-reading the configuration. | |
void | removeConfigCacheEntry (const QString &path) override |
Remove entry from config cache. | |
QgsRequestHandler * | requestHandler () override |
Returns the QgsRequestHandler, to be used only in server plugins. | |
QgsServerSettings * | serverSettings () override |
Returns the server settings. | |
QgsServiceRegistry * | serviceRegistry () override |
Returns the service registry. | |
void | setConfigFilePath (const QString &configFilePath) override |
Set the configuration file path. | |
void | setFilters (QgsServerFiltersMap *filters) override |
Set the filters map. | |
void | setRequestHandler (QgsRequestHandler *requestHandler) override |
Set the request handler. | |
Public Member Functions inherited from QgsServerInterface | |
QgsServerInterface () | |
Constructor. | |
virtual | ~QgsServerInterface ()=default |
Interfaces exposed by QGIS Server and made available to plugins.
Definition at line 34 of file qgsserverinterfaceimpl.h.
|
explicit |
Constructor.
Definition at line 24 of file qgsserverinterfaceimpl.cpp.
|
override |
Definition at line 42 of file qgsserverinterfaceimpl.cpp.
|
inlineoverridevirtual |
Gets the helper over all the registered access control filters.
Implements QgsServerInterface.
Definition at line 61 of file qgsserverinterfaceimpl.h.
|
overridevirtual |
Gets the helper over all the registered server cache filters.
Implements QgsServerInterface.
Definition at line 98 of file qgsserverinterfaceimpl.cpp.
|
inlineoverridevirtual |
Gets pointer to the capabiblities cache.
Implements QgsServerInterface.
Definition at line 48 of file qgsserverinterfaceimpl.h.
|
overridevirtual |
Clear the request handler.
Implements QgsServerInterface.
Definition at line 51 of file qgsserverinterfaceimpl.cpp.
|
inlineoverridevirtual |
Returns the configuration file path.
Implements QgsServerInterface.
Definition at line 80 of file qgsserverinterfaceimpl.h.
|
inlineoverridevirtual |
Returns the list of current QgsServerFilter.
Implements QgsServerInterface.
Definition at line 52 of file qgsserverinterfaceimpl.h.
|
overridevirtual |
Returns an enrironment variable, used to pass environment variables to Python.
Implements QgsServerInterface.
Definition at line 36 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Register an access control filter.
Register a new access control filter.
Implements QgsServerInterface.
Definition at line 77 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Register a QgsServerFilter.
filter | the QgsServerFilter to add |
priority | an optional priority for the filter order |
Implements QgsServerInterface.
Definition at line 66 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Registers a server cache filter.
Register a new access control filter.
serverCache | the server cache to register |
priority | the priority used to order them |
Implements QgsServerInterface.
Definition at line 88 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Reloads the server settings re-reading the configuration.
Implements QgsServerInterface.
Definition at line 122 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Remove entry from config cache.
path | the path of the file to remove |
Implements QgsServerInterface.
Definition at line 103 of file qgsserverinterfaceimpl.cpp.
|
inlineoverridevirtual |
Returns the QgsRequestHandler, to be used only in server plugins.
Implements QgsServerInterface.
Definition at line 50 of file qgsserverinterfaceimpl.h.
|
overridevirtual |
Returns the server settings.
Implements QgsServerInterface.
Definition at line 117 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Returns the service registry.
Implements QgsServerInterface.
Definition at line 112 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Set the configuration file path.
configFilePath | QString with the configuration file path |
Implements QgsServerInterface.
Definition at line 61 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Set the filters map.
filters | the QgsServerFiltersMap |
Implements QgsServerInterface.
Definition at line 71 of file qgsserverinterfaceimpl.cpp.
|
overridevirtual |
Set the request handler.
requestHandler | request handler |
Implements QgsServerInterface.
Definition at line 56 of file qgsserverinterfaceimpl.cpp.