QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | List of all members
QgsServerInterface Class Referenceabstract
server library

QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins. More...

#include <qgsserverinterface.h>

Inheritance diagram for QgsServerInterface:
Inheritance graph
[legend]

Public Member Functions

 QgsServerInterface ()
 Constructor. More...
 
virtual ~QgsServerInterface ()=default
 
virtual QgsAccessControl * accessControls () const =0
 Gets the registered access control filters. More...
 
virtual QgsServerCacheManager * cacheManager () const =0
 Gets the registered server cache filters. More...
 
virtual QgsCapabilitiesCache * capabilitiesCache ()=0
 Gets pointer to the capabiblities cache. More...
 
virtual void clearRequestHandler ()=0
 Clear the request handler. More...
 
virtual QString configFilePath ()=0
 Returns the configuration file path. More...
 
virtual QgsServerFiltersMap filters ()=0
 Returns the list of current QgsServerFilter. More...
 
virtual QString getEnv (const QString &name) const =0
 Returns an enrironment variable, used to pass environment variables to Python. More...
 
virtual void registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0)=0
 Register an access control filter. More...
 
virtual void registerFilter (QgsServerFilter *filter, int priority=0)=0
 Register a QgsServerFilter. More...
 
virtual void registerServerCache (QgsServerCacheFilter *serverCache, int priority=0)=0
 Register a server cache filter. More...
 
virtual void removeConfigCacheEntry (const QString &path)=0
 Remove entry from config cache. More...
 
virtual QgsRequestHandler * requestHandler ()=0
 Gets pointer to the request handler. More...
 
virtual QgsServerSettings * serverSettings ()=0
 Returns the server settings. More...
 
virtual QgsServiceRegistry * serviceRegistry ()=0
 Returns the service registry. More...
 
virtual void setConfigFilePath (const QString &configFilePath)=0
 Set the configuration file path. More...
 
virtual void setFilters (QgsServerFiltersMap *filters)=0
 Set the filters map. More...
 
virtual void setRequestHandler (QgsRequestHandler *requestHandler)=0
 Set the request handler. More...
 

Detailed Description

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( QgsServerFilter* , int) method.

Definition at line 60 of file qgsserverinterface.h.

Constructor & Destructor Documentation

◆ QgsServerInterface()

QgsServerInterface::QgsServerInterface ( )

Constructor.

Definition at line 22 of file qgsserverinterface.cpp.

◆ ~QgsServerInterface()

virtual QgsServerInterface::~QgsServerInterface ( )
virtualdefault

Member Function Documentation

◆ accessControls()

virtual QgsAccessControl* QgsServerInterface::accessControls ( ) const
pure virtual

Gets the registered access control filters.

Implemented in QgsServerInterfaceImpl.

◆ cacheManager()

virtual QgsServerCacheManager* QgsServerInterface::cacheManager ( ) const
pure virtual

Gets the registered server cache filters.

Since
QGIS 3.4

Implemented in QgsServerInterfaceImpl.

◆ capabilitiesCache()

virtual QgsCapabilitiesCache* QgsServerInterface::capabilitiesCache ( )
pure virtual

Gets pointer to the capabiblities cache.

Returns
QgsCapabilitiesCache

Implemented in QgsServerInterfaceImpl.

◆ clearRequestHandler()

virtual void QgsServerInterface::clearRequestHandler ( )
pure virtual

Clear the request handler.

Note
not available in Python bindings

Implemented in QgsServerInterfaceImpl.

◆ configFilePath()

virtual QString QgsServerInterface::configFilePath ( )
pure virtual

Returns the configuration file path.

Returns
QString containing the configuration file path

Implemented in QgsServerInterfaceImpl.

◆ filters()

virtual QgsServerFiltersMap QgsServerInterface::filters ( )
pure virtual

Returns the list of current QgsServerFilter.

Returns
QgsServerFiltersMap list of QgsServerFilter

Implemented in QgsServerInterfaceImpl.

◆ getEnv()

virtual QString QgsServerInterface::getEnv ( const QString &  name) const
pure virtual

Returns an enrironment variable, used to pass environment variables to Python.

Implemented in QgsServerInterfaceImpl.

◆ registerAccessControl()

virtual void QgsServerInterface::registerAccessControl ( QgsAccessControlFilter *  accessControl,
int  priority = 0 
)
pure virtual

Register an access control filter.

Parameters
accessControlthe access control to register
prioritythe priority used to order them

Implemented in QgsServerInterfaceImpl.

◆ registerFilter()

virtual void QgsServerInterface::registerFilter ( QgsServerFilter *  filter,
int  priority = 0 
)
pure virtual

Register a QgsServerFilter.

Parameters
filterthe QgsServerFilter to add
priorityan optional priority for the filter order

Implemented in QgsServerInterfaceImpl.

◆ registerServerCache()

virtual void QgsServerInterface::registerServerCache ( QgsServerCacheFilter *  serverCache,
int  priority = 0 
)
pure virtual

Register a server cache filter.

Parameters
serverCachethe server cache to register
prioritythe priority used to order them
Since
QGIS 3.4

Implemented in QgsServerInterfaceImpl.

◆ removeConfigCacheEntry()

virtual void QgsServerInterface::removeConfigCacheEntry ( const QString &  path)
pure virtual

Remove entry from config cache.

Parameters
paththe path of the file to remove

Implemented in QgsServerInterfaceImpl.

◆ requestHandler()

virtual QgsRequestHandler* QgsServerInterface::requestHandler ( )
pure virtual

Gets pointer to the request handler.

Returns
QgsRequestHandler

Implemented in QgsServerInterfaceImpl.

◆ serverSettings()

virtual QgsServerSettings* QgsServerInterface::serverSettings ( )
pure virtual

Returns the server settings.

Returns
QgsServerSettings
Note
not available in Python bindings

Implemented in QgsServerInterfaceImpl.

◆ serviceRegistry()

virtual QgsServiceRegistry* QgsServerInterface::serviceRegistry ( )
pure virtual

Returns the service registry.

Returns
QgsServiceResgistry

Implemented in QgsServerInterfaceImpl.

◆ setConfigFilePath()

virtual void QgsServerInterface::setConfigFilePath ( const QString &  configFilePath)
pure virtual

Set the configuration file path.

Parameters
configFilePathQString with the configuration file path

Implemented in QgsServerInterfaceImpl.

◆ setFilters()

virtual void QgsServerInterface::setFilters ( QgsServerFiltersMap *  filters)
pure virtual

Set the filters map.

Parameters
filtersthe QgsServerFiltersMap

Implemented in QgsServerInterfaceImpl.

◆ setRequestHandler()

virtual void QgsServerInterface::setRequestHandler ( QgsRequestHandler *  requestHandler)
pure virtual

Set the request handler.

Parameters
requestHandlerrequest handler
Note
not available in Python bindings

Implemented in QgsServerInterfaceImpl.

The documentation for this class was generated from the following files:
Generated on Sun Jun 20 2021 10:45:59 for QGIS API Documentation by doxygen 1.9.1