QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | List of all members
QgsServerInterface Class Referenceabstract

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 QgsCapabilitiesCachecapabiblitiesCache ()=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 QgsRequestHandlerrequestHandler ()=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 ( )

Constructor.

virtual QgsServerInterface::~QgsServerInterface ( )
pure virtual

Destructor.

Member Function Documentation

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

Gets the registred access control filters.

virtual QgsCapabilitiesCache* QgsServerInterface::capabiblitiesCache ( )
pure virtual

Get pointer to the capabiblities cache.

Returns
QgsCapabilitiesCache
virtual void QgsServerInterface::clearRequestHandler ( )
pure virtual

Clear the request handler.

Note
not available in python bindings
virtual QString QgsServerInterface::configFilePath ( )
pure virtual

Return the configuration file path.

Returns
QString containing the configuration file path
virtual QgsServerFiltersMap QgsServerInterface::filters ( )
pure virtual

Return the list of current QgsServerFilter.

Returns
QgsServerFiltersMap list of QgsServerFilter
virtual QString QgsServerInterface::getEnv ( const QString name) const
pure virtual

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

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
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
virtual void QgsServerInterface::removeConfigCacheEntry ( const QString path)
pure virtual

Remove entry from config cache.

Parameters
paththe path of the file to remove
virtual void QgsServerInterface::removeProjectLayers ( const QString path)
pure virtual

Remove entries from layer cache.

Parameters
paththe path of the project which own the layers to be removed
virtual QgsRequestHandler* QgsServerInterface::requestHandler ( )
pure virtual

Get pointer to the request handler.

Returns
QgsRequestHandler
virtual void QgsServerInterface::setConfigFilePath ( const QString configFilePath)
pure virtual

Set the configuration file path.

Parameters
configFilePathQString with the configuration file path
virtual void QgsServerInterface::setFilters ( QgsServerFiltersMap filters)
pure virtual

Set the filters map.

Parameters
filtersthe QgsServerFiltersMap
virtual void QgsServerInterface::setRequestHandler ( QgsRequestHandler requestHandler)
pure virtual

Set the request handler.

Parameters
requestHandlerrequest handler
Note
not available in Python bindings

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