QgsAccessControl Class Reference

A helper class that centralizes restrictions given by all the access control filter plugins. More...

#include <qgsaccesscontrol.h>

Inheritance diagram for QgsAccessControl:

Public Member Functions
	QgsAccessControl ()
	Constructor.
	QgsAccessControl (const QgsAccessControl &copy)
	~QgsAccessControl () override
bool	allowToEdit (const QgsVectorLayer *layer, const QgsFeature &feature) const
	Are we authorized to modify the following geometry.
QgsAccessControl *	clone () const override
	Clone the object.
QString	extraSubsetString (const QgsVectorLayer *layer) const
	Returns an additional subset string (typically SQL) filter.
bool	fillCacheKey (QStringList &cacheKey) const
	Fill the capabilities caching key.
void	filterFeatures (const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
	Filter the features of the layer.
bool	isFilterThreadSafe () const override
	Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.
QStringList	layerAttributes (const QgsVectorLayer *layer, const QStringList &attributes) const override
	Returns the authorized layer attributes.
bool	layerDeletePermission (const QgsVectorLayer *layer) const
	Returns the layer delete right.
bool	layerInsertPermission (const QgsVectorLayer *layer) const
	Returns the layer insert right.
bool	layerReadPermission (const QgsMapLayer *layer) const
	Returns the layer read right.
bool	layerUpdatePermission (const QgsVectorLayer *layer) const
	Returns the layer update right.
QgsAccessControl &	operator= (const QgsAccessControl &other)
void	registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0)
	Register an access control filter.
void	resolveFilterFeatures (const QList< QgsMapLayer * > &layers)
	Resolve features' filter of layers The method fetch filter's expressions returned from access control plugins and and combine them to a unique expression for each layer.
void	unresolveFilterFeatures ()
	Clear expression's cache computed from resolveFilterFeatures
Public Member Functions inherited from QgsFeatureFilterProvider
	QgsFeatureFilterProvider ()=default
virtual	~QgsFeatureFilterProvider ()=default
virtual void	filterFeatures (const QString &layerId, QgsFeatureRequest &featureRequest) const
	Add additional filters to the feature request to further restrict the features returned by the request.

Detailed Description

A helper class that centralizes restrictions given by all the access control filter plugins.

Definition at line 35 of file qgsaccesscontrol.h.

Constructor & Destructor Documentation

QgsAccessControl() [1/2]

QgsAccessControl::QgsAccessControl ( )

inline

Constructor.

Definition at line 43 of file qgsaccesscontrol.h.

QgsAccessControl() [2/2]

QgsAccessControl::QgsAccessControl ( const QgsAccessControl &  copy )

inline

Definition at line 49 of file qgsaccesscontrol.h.

~QgsAccessControl()

QgsAccessControl::~QgsAccessControl ( )

inlineoverride

Definition at line 57 of file qgsaccesscontrol.h.

Member Function Documentation

allowToEdit()

bool QgsAccessControl::allowToEdit	(	const QgsVectorLayer *	layer,
		const QgsFeature &	feature
	)		const

Are we authorized to modify the following geometry.

Parameters

layer	the layer to control
feature	the concerned feature

Returns

true if we are allowed to edit the feature

Definition at line 179 of file qgsaccesscontrol.cpp.

clone()

QgsAccessControl * QgsAccessControl::clone ( ) const

overridevirtual

Clone the object.

Implements QgsFeatureFilterProvider.

Definition at line 89 of file qgsaccesscontrol.cpp.

extraSubsetString()

QString QgsAccessControl::extraSubsetString

(

const QgsVectorLayer *

layer

)

const

Returns an additional subset string (typically SQL) filter.

Parameters

layer

the layer to control

Returns

the subset string to use

Definition at line 95 of file qgsaccesscontrol.cpp.

fillCacheKey()

bool QgsAccessControl::fillCacheKey

(

QStringList &

cacheKey

)

const

Fill the capabilities caching key.

Parameters

cacheKey

the list to fill with a cache variant

Definition at line 193 of file qgsaccesscontrol.cpp.

filterFeatures()

void QgsAccessControl::filterFeatures ( const QgsVectorLayer *  layer, QgsFeatureRequest &  filterFeatures  ) const

overridevirtual

Filter the features of the layer.

Reimplemented from QgsFeatureFilterProvider.

Definition at line 69 of file qgsaccesscontrol.cpp.

isFilterThreadSafe()

bool QgsAccessControl::isFilterThreadSafe ( ) const

inlineoverridevirtual

Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.

Since

QGIS 4.0

Deprecated:

QGIS 4.0

Reimplemented from QgsFeatureFilterProvider.

Definition at line 74 of file qgsaccesscontrol.h.

layerAttributes()

QStringList QgsAccessControl::layerAttributes ( const QgsVectorLayer *  layer, const QStringList &  attributes  ) const

overridevirtual

Returns the authorized layer attributes.

Implements QgsFeatureFilterProvider.

Definition at line 167 of file qgsaccesscontrol.cpp.

layerDeletePermission()

bool QgsAccessControl::layerDeletePermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer delete right.

Parameters

layer

the layer to control

Returns

true if we can do a delete

Definition at line 153 of file qgsaccesscontrol.cpp.

layerInsertPermission()

bool QgsAccessControl::layerInsertPermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer insert right.

Parameters

layer

the layer to control

Returns

true if we can insert on it

Definition at line 125 of file qgsaccesscontrol.cpp.

layerReadPermission()

bool QgsAccessControl::layerReadPermission

(

const QgsMapLayer *

layer

)

const

Returns the layer read right.

Parameters

layer

the layer to control

Returns

true if it can be read

Definition at line 111 of file qgsaccesscontrol.cpp.

layerUpdatePermission()

bool QgsAccessControl::layerUpdatePermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer update right.

Parameters

layer

the layer to control

Returns

true if we can do an update

Definition at line 139 of file qgsaccesscontrol.cpp.

operator=()

QgsAccessControl & QgsAccessControl::operator= ( const QgsAccessControl &  other )

inline

Definition at line 62 of file qgsaccesscontrol.h.

registerAccessControl()

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

Register an access control filter.

Register a new access control filter.

Parameters

accessControl	the access control to add
priority	the priority used to define the order

Definition at line 209 of file qgsaccesscontrol.cpp.

resolveFilterFeatures()

void QgsAccessControl::resolveFilterFeatures

(

const QList< QgsMapLayer * > &

layers

)

Resolve features' filter of layers The method fetch filter's expressions returned from access control plugins and and combine them to a unique expression for each layer.

The resulted expressions are stored in cache for efficiency; between each requests, the cache must be cleared using 'unresolveFilterFeatures()'.

Parameters

layers

to filter

Definition at line 24 of file qgsaccesscontrol.cpp.

unresolveFilterFeatures()

void QgsAccessControl::unresolveFilterFeatures

(

)

Clear expression's cache computed from resolveFilterFeatures

Clear feature's filter of layers.

Definition at line 62 of file qgsaccesscontrol.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsaccesscontrol.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsaccesscontrol.cpp