QgsServerInterface Class Reference

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

#include <qgsserverinterface.h>

Public Member Functions
	QgsServerInterface ()
	Constructor. More...
virtual	~QgsServerInterface ()=0
	Destructor. More...
virtual const QgsAccessControl *	accessControls () const =0
	Gets the registred access control filters. More...
virtual QgsCapabilitiesCache *	capabiblitiesCache ()=0
	Get pointer to the capabiblities cache. More...
virtual void	clearRequestHandler ()=0
	Clear the request handler. More...
virtual QString	configFilePath ()=0
	Return the configuration file path. More...
virtual QgsServerFiltersMap	filters ()=0
	Return the list of current QgsServerFilter. More...
virtual QString	getEnv (const QString &name) const =0
	Return 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	removeConfigCacheEntry (const QString &path)=0
	Remove entry from config cache. More...
virtual void	removeProjectLayers (const QString &path)=0
	Remove entries from layer cache. More...
virtual QgsRequestHandler *	requestHandler ()=0
	Get pointer to the request handler. 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.

Definition at line 36 of file qgsserverinterface.h.

Constructor & Destructor Documentation

QgsServerInterface()

QgsServerInterface::QgsServerInterface

(

)

Constructor.

~QgsServerInterface()

virtual QgsServerInterface::~QgsServerInterface ( )

pure virtual

Destructor.

Member Function Documentation

accessControls()

virtual const QgsAccessControl* QgsServerInterface::accessControls ( ) const

pure virtual

Gets the registred access control filters.

capabiblitiesCache()

virtual QgsCapabilitiesCache* QgsServerInterface::capabiblitiesCache ( )

pure virtual

Get pointer to the capabiblities cache.

Returns

QgsCapabilitiesCache

clearRequestHandler()

virtual void QgsServerInterface::clearRequestHandler ( )

pure virtual

Clear the request handler.

Note

not available in python bindings

configFilePath()

virtual QString QgsServerInterface::configFilePath ( )

pure virtual

Return the configuration file path.

Returns

QString containing the configuration file path

filters()

virtual QgsServerFiltersMap QgsServerInterface::filters ( )

pure virtual

Return the list of current QgsServerFilter.

Returns

QgsServerFiltersMap list of QgsServerFilter

getEnv()

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

pure virtual

Return an enrironment variable, used to pass environment variables to python.

registerAccessControl()

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

registerFilter()

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

removeConfigCacheEntry()

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

pure virtual

Remove entry from config cache.

Parameters

path	the path of the file to remove

removeProjectLayers()

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

pure virtual

Remove entries from layer cache.

Parameters

path	the path of the project which own the layers to be removed

requestHandler()

virtual QgsRequestHandler* QgsServerInterface::requestHandler ( )

pure virtual

Get pointer to the request handler.

Returns

QgsRequestHandler

setConfigFilePath()

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

pure virtual

Set the configuration file path.

Parameters

configFilePath

QString with the configuration file path

setFilters()

virtual void QgsServerInterface::setFilters ( QgsServerFiltersMap *  filters )

pure virtual

Set the filters map.

Parameters

filters

the QgsServerFiltersMap

setRequestHandler()

virtual void QgsServerInterface::setRequestHandler ( QgsRequestHandler *  requestHandler )

pure virtual

Set the request handler.

Parameters

requestHandler

request handler

Note

not available in Python bindings

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/server/qgsserverinterface.h