Class: QgsAccessControlFilter

class qgis.server.QgsAccessControlFilter

Bases: sip.wrapper

Class defining access control interface for QGIS Server plugins.

Security can define any (or none) of the following method:

QgsAccessControlFilter(serverInterface: QgsServerInterface) Constructor QgsServerInterface passed to plugins constructors and must be passed to QgsAccessControlFilter instances.

QgsAccessControlFilter(QgsAccessControlFilter)

Methods

allowToEdit

Are we authorized to modify the following geometry

authorizedLayerAttributes

Returns the authorized layer attributes

cacheKey

Cache key to used to create the capabilities cache

layerFilterExpression

Returns an additional expression filter

layerFilterSubsetString

Returns an additional subset string (typically SQL) filter

layerPermissions

Returns the layer permissions

serverInterface

Returns the QgsServerInterface instance

class LayerPermissions
class LayerPermissions(QgsAccessControlFilter.LayerPermissions)

Bases: sip.wrapper

canDelete
canInsert
canRead
canUpdate
allowToEdit(self, layer: QgsVectorLayer, feature: QgsFeature) bool

Are we authorized to modify the following geometry

Parameters:
Return type:

bool

Returns:

True if we are allowed to edit

authorizedLayerAttributes(self, layer: QgsVectorLayer, attributes: Iterable[str]) List[str]

Returns the authorized layer attributes

Parameters:
  • layer (QgsVectorLayer) – the layer to control

  • attributes (Iterable[str]) – the current list of visible attribute

Return type:

List[str]

Returns:

the new list of visible attributes

cacheKey(self) str

Cache key to used to create the capabilities cache

Return type:

str

Returns:

the cache key, “” for no cache

layerFilterExpression(self, layer: QgsVectorLayer) str

Returns an additional expression filter

Parameters:

layer (QgsVectorLayer) – the layer to control

Return type:

str

Returns:

the filter expression

layerFilterSubsetString(self, layer: QgsVectorLayer) str

Returns an additional subset string (typically SQL) filter

Parameters:

layer (QgsVectorLayer) – the layer to control

Return type:

str

Returns:

the subset string

layerPermissions(self, layer: QgsMapLayer) QgsAccessControlFilter.LayerPermissions

Returns the layer permissions

Parameters:

layer (QgsMapLayer) – the layer to control

Return type:

QgsAccessControlFilter.LayerPermissions

Returns:

the permission to use on the layer

serverInterface(self) QgsServerInterface

Returns the QgsServerInterface instance

Return type:

QgsServerInterface