QgsServerInterface Class Reference

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

#include <qgsserverinterface.h>

Inheritance diagram for QgsServerInterface:

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 61 of file qgsserverinterface.h.

Constructor & Destructor Documentation

QgsServerInterface::QgsServerInterface

(

)

Constructor.

Definition at line 22 of file qgsserverinterface.cpp.

virtual QgsServerInterface::~QgsServerInterface ( )

virtualdefault

Member Function Documentation

virtual QgsAccessControl* QgsServerInterface::accessControls ( ) const

pure virtual

Gets the registered access control filters.

Implemented in QgsServerInterfaceImpl.

virtual QgsServerCacheManager* QgsServerInterface::cacheManager ( ) const

pure virtual

Gets the registered server cache filters.

Since

QGIS 3.4

Implemented in QgsServerInterfaceImpl.

virtual QgsCapabilitiesCache* QgsServerInterface::capabilitiesCache ( )

pure virtual

Gets pointer to the capabiblities cache.

Returns

QgsCapabilitiesCache

Implemented in QgsServerInterfaceImpl.

virtual void QgsServerInterface::clearRequestHandler ( )

pure virtual

Clear the request handler.

Note

not available in Python bindings

Implemented in QgsServerInterfaceImpl.

virtual QString QgsServerInterface::configFilePath ( )

pure virtual

Returns the configuration file path.

Returns

QString containing the configuration file path

Implemented in QgsServerInterfaceImpl.

virtual QgsServerFiltersMap QgsServerInterface::filters ( )

pure virtual

Returns the list of current QgsServerFilter.

Returns

QgsServerFiltersMap list of QgsServerFilter

Implemented in QgsServerInterfaceImpl.

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

pure virtual

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

Implemented in QgsServerInterfaceImpl.

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

pure virtual

Register an access control filter.

Parameters

accessControl	the access control to register
priority	the priority used to order them

Implemented in QgsServerInterfaceImpl.

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

pure virtual

Register a QgsServerFilter.

Parameters

filter	the QgsServerFilter to add
priority	an optional priority for the filter order

Implemented in QgsServerInterfaceImpl.

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

pure virtual

Register a server cache filter.

Parameters

serverCache	the server cache to register
priority	the priority used to order them

Since

QGIS 3.4

Implemented in QgsServerInterfaceImpl.

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

pure virtual

Remove entry from config cache.

Parameters

path	the path of the file to remove

Implemented in QgsServerInterfaceImpl.

virtual QgsRequestHandler* QgsServerInterface::requestHandler ( )

pure virtual

Gets pointer to the request handler.

Returns

QgsRequestHandler

Implemented in QgsServerInterfaceImpl.

virtual QgsServerSettings* QgsServerInterface::serverSettings ( )

pure virtual

Returns the server settings.

Returns

QgsServerSettings

Note

not available in Python bindings

Implemented in QgsServerInterfaceImpl.

virtual QgsServiceRegistry* QgsServerInterface::serviceRegistry ( )

pure virtual

Returns the service registry.

Returns

QgsServiceResgistry

Implemented in QgsServerInterfaceImpl.

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

pure virtual

Set the configuration file path.

Parameters

configFilePath

QString with the configuration file path

Implemented in QgsServerInterfaceImpl.

virtual void QgsServerInterface::setFilters ( QgsServerFiltersMap *  filters )

pure virtual

Set the filters map.

Parameters

filters

the QgsServerFiltersMap

Implemented in QgsServerInterfaceImpl.

virtual void QgsServerInterface::setRequestHandler ( QgsRequestHandler *  requestHandler )

pure virtual

Set the request handler.

Parameters

requestHandler

request handler

Note

not available in Python bindings

Implemented in QgsServerInterfaceImpl.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.4.15+24xenial/src/server/qgsserverinterface.h
• /build/qgis-3.4.15+24xenial/src/server/qgsserverinterface.cpp