QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins. More...
#include <qgsserverinterface.h>
Public Member Functions | |
QgsServerInterface () | |
Constructor. | |
virtual | ~QgsServerInterface ()=default |
virtual QgsAccessControl * | accessControls () const =0 |
Gets the registered access control filters. | |
virtual QgsServerCacheManager * | cacheManager () const =0 |
Gets the registered server cache filters. | |
virtual QgsCapabilitiesCache * | capabilitiesCache ()=0 |
Gets pointer to the capabiblities cache. | |
virtual void | clearRequestHandler ()=0 |
Clear the request handler. | |
virtual QString | configFilePath ()=0 |
Returns the configuration file path. | |
virtual QgsServerFiltersMap | filters ()=0 |
Returns the list of current QgsServerFilter. | |
virtual QString | getEnv (const QString &name) const =0 |
Returns an enrironment variable, used to pass environment variables to Python. | |
virtual void | registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0)=0 |
Register an access control filter. | |
virtual void | registerFilter (QgsServerFilter *filter, int priority=0)=0 |
Register a QgsServerFilter. | |
virtual void | registerServerCache (QgsServerCacheFilter *serverCache, int priority=0)=0 |
Register a server cache filter. | |
virtual void | reloadSettings ()=0 |
Reloads the server settings re-reading the configuration. | |
virtual void | removeConfigCacheEntry (const QString &path)=0 |
Remove entry from config cache. | |
virtual QgsRequestHandler * | requestHandler ()=0 |
Gets pointer to the request handler. | |
virtual QgsServerSettings * | serverSettings ()=0 |
Returns the server settings. | |
virtual QgsServiceRegistry * | serviceRegistry ()=0 |
Returns the service registry. | |
virtual void | setConfigFilePath (const QString &configFilePath)=0 |
Set the configuration file path. | |
virtual void | setFilters (QgsServerFiltersMap *filters)=0 |
Set the filters map. | |
virtual void | setRequestHandler (QgsRequestHandler *requestHandler)=0 |
Set the request handler. | |
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 QgsServerFilter) with a certain priority through the registerFilter() method.
Definition at line 60 of file qgsserverinterface.h.
QgsServerInterface::QgsServerInterface | ( | ) |
Constructor.
Definition at line 22 of file qgsserverinterface.cpp.
|
virtualdefault |
|
pure virtual |
Gets the registered access control filters.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
|
pure virtual |
Gets pointer to the capabiblities cache.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Clear the request handler.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Returns the configuration file path.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Returns the list of current QgsServerFilter.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Returns an enrironment variable, used to pass environment variables to Python.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Register an access control filter.
accessControl | the access control to register |
priority | the priority used to order them |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Register a QgsServerFilter.
filter | the QgsServerFilter to add |
priority | an optional priority for the filter order |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Register a server cache filter.
serverCache | the server cache to register |
priority | the priority used to order them |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Reloads the server settings re-reading the configuration.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Remove entry from config cache.
path | the path of the file to remove |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Gets pointer to the request handler.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Returns the server settings.
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
|
pure virtual |
Set the configuration file path.
configFilePath | QString with the configuration file path |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Set the filters map.
filters | the QgsServerFiltersMap |
Implemented in QgsServerInterfaceImpl.
|
pure virtual |
Set the request handler.
requestHandler | request handler |
Implemented in QgsServerInterfaceImpl.