Configuration storage class for authentication method configurations. More...

#include <qgsauthconfig.h>

Public Member Functions
	QgsAuthMethodConfig (const QString &method=QString(), int version=0)
	Construct a configuration for an authentication method. More...

void	clearConfigMap ()
	Clear all configs. More...

QString	config (const QString &key, const QString &defaultvalue=QString()) const
	Return a config's value. More...

QStringList	configList (const QString &key) const
	Return a config's list of values. More...

QgsStringMap	configMap () const
	Get extended configuration, mapped to key/value pairs of QStrings. More...

const QString	configString () const
	The extended configuration, as stored and retrieved from the authentication database. More...

bool	hasConfig (const QString &key) const
	Whether a config key exists in config map. More...

const QString	id () const
	Get 'authcfg' 7-character alphanumeric ID of the config. More...

bool	isValid (bool validateid=false) const
	Whether the configuration is valid. More...

void	loadConfigString (const QString &configstr)
	Load existing extended configuration. More...

QString	method () const
	Textual key of the associated authentication method. More...

const QString	name () const
	Get name of configuration. More...

bool	operator!= (const QgsAuthMethodConfig &other) const
	Operator used to compare configs' inequality. More...

bool	operator== (const QgsAuthMethodConfig &other) const
	Operator used to compare configs' equality. More...

int	removeConfig (const QString &key)
	Remove a config from map. More...

void	setConfig (const QString &key, const QString &value)
	Set a single config value per key in the map. More...

void	setConfigList (const QString &key, const QStringList &value)
	Set a multiple config values per key in the map. More...

void	setConfigMap (const QgsStringMap &map)
	Set extended configuration map. More...

void	setId (const QString &id)
	Set auth config ID. More...

void	setMethod (const QString &method)

void	setName (const QString &name)
	Set name of configuration. More...

void	setUri (const QString &uri)

void	setVersion (int version)
	Set version of the configuration. More...

const QString	uri () const
	A URI to auto-select a config when connecting to a resource. More...

int	version () const
	Get version of the configuration. More...

Static Public Member Functions
static bool	uriToResource (const QString &accessurl, QString *resource, bool withpath=false)
	A utility function for generating a resource from a URL to be compared against the config's uri() for auto-selecting authentication configs to use. More...

Detailed Description

Configuration storage class for authentication method configurations.

Definition at line 36 of file qgsauthconfig.h.

Constructor & Destructor Documentation

◆ QgsAuthMethodConfig()

QgsAuthMethodConfig::QgsAuthMethodConfig	(	const QString &	method = `QString()`,
		int	version = `0`
	)

Construct a configuration for an authentication method.

Parameters

method	Textual key of the authentication method
version	Version of the configuration (for updating previously saved configs later on)

Definition at line 39 of file qgsauthconfig.cpp.

Member Function Documentation

◆ clearConfigMap()

void QgsAuthMethodConfig::clearConfigMap ( )

inline

Clear all configs.

Definition at line 146 of file qgsauthconfig.h.

◆ config()

QString QgsAuthMethodConfig::config	(	const QString &	key,
		const QString &	defaultvalue = `QString()`
	)		const

Return a config's value.

Parameters

key	Config key
defaultvalue	Default value, if key not found

Definition at line 127 of file qgsauthconfig.cpp.

◆ configList()

QStringList QgsAuthMethodConfig::configList ( const QString & key ) const

Return a config's list of values.

Parameters

key

Definition at line 132 of file qgsauthconfig.cpp.

◆ configMap()

QgsStringMap QgsAuthMethodConfig::configMap ( ) const

inline

Get extended configuration, mapped to key/value pairs of QStrings.

Definition at line 97 of file qgsauthconfig.h.

◆ configString()

const QString QgsAuthMethodConfig::configString ( ) const

The extended configuration, as stored and retrieved from the authentication database.

Note: This is an internal construct used by QgsAuthManager that should generally not be set by client code

Definition at line 75 of file qgsauthconfig.cpp.

◆ hasConfig()

bool QgsAuthMethodConfig::hasConfig ( const QString & key ) const

Whether a config key exists in config map.

Parameters

key

Definition at line 137 of file qgsauthconfig.cpp.

◆ id()

const QString QgsAuthMethodConfig::id ( ) const

inline

Get 'authcfg' 7-character alphanumeric ID of the config.

Note: This is set by QgsAuthManager when the config is initially stored

Definition at line 57 of file qgsauthconfig.h.

◆ isValid()

bool QgsAuthMethodConfig::isValid ( bool validateid = false ) const

Whether the configuration is valid.

Parameters

validateid Additionally verify the auth config ID is not empty

Definition at line 64 of file qgsauthconfig.cpp.

◆ loadConfigString()

void QgsAuthMethodConfig::loadConfigString ( const QString & configstr )

Load existing extended configuration.

Parameters

configstr Configuration string to load

Definition at line 87 of file qgsauthconfig.cpp.

◆ method()

QString QgsAuthMethodConfig::method ( ) const

inline

Textual key of the associated authentication method.

Definition at line 71 of file qgsauthconfig.h.

◆ name()

const QString QgsAuthMethodConfig::name ( ) const

inline

Get name of configuration.

Definition at line 62 of file qgsauthconfig.h.

◆ operator!=()

bool QgsAuthMethodConfig::operator!= ( const QgsAuthMethodConfig & other ) const

Operator used to compare configs' inequality.

Definition at line 59 of file qgsauthconfig.cpp.

◆ operator==()

bool QgsAuthMethodConfig::operator== ( const QgsAuthMethodConfig & other ) const

Operator used to compare configs' equality.

Definition at line 49 of file qgsauthconfig.cpp.

◆ removeConfig()

int QgsAuthMethodConfig::removeConfig ( const QString & key )

Remove a config from map.

Parameters

key	Config to remove

Returns: Number of keys removed (should always be 1 or 0)

Definition at line 122 of file qgsauthconfig.cpp.

◆ setConfig()

void QgsAuthMethodConfig::setConfig	(	const QString &	key,
		const QString &	value
	)

Set a single config value per key in the map.

Note: if key exists, it is replaced

Parameters

key	Config key
value	Config value

Definition at line 112 of file qgsauthconfig.cpp.

◆ setConfigList()

void QgsAuthMethodConfig::setConfigList	(	const QString &	key,
		const QStringList &	value
	)

Set a multiple config values per key in the map.

Note: if key exists, it is replaced

Parameters

key	Config key
value	Config value

Definition at line 117 of file qgsauthconfig.cpp.

◆ setConfigMap()

void QgsAuthMethodConfig::setConfigMap ( const QgsStringMap & map )

inline

Set extended configuration map.

Parameters

map	Map to set

Definition at line 102 of file qgsauthconfig.h.

◆ setId()

void QgsAuthMethodConfig::setId ( const QString & id )

inline

Set auth config ID.

Definition at line 59 of file qgsauthconfig.h.

◆ setMethod()

void QgsAuthMethodConfig::setMethod ( const QString & method )

inline

Definition at line 72 of file qgsauthconfig.h.

◆ setName()

void QgsAuthMethodConfig::setName ( const QString & name )

inline

Set name of configuration.

Definition at line 64 of file qgsauthconfig.h.

◆ setUri()

void QgsAuthMethodConfig::setUri ( const QString & uri )

inline

Definition at line 68 of file qgsauthconfig.h.

◆ setVersion()

void QgsAuthMethodConfig::setVersion ( int version )

inline

Set version of the configuration.

Definition at line 77 of file qgsauthconfig.h.

◆ uri()

const QString QgsAuthMethodConfig::uri ( ) const

inline

A URI to auto-select a config when connecting to a resource.

Definition at line 67 of file qgsauthconfig.h.

◆ uriToResource()

bool QgsAuthMethodConfig::uriToResource	(	const QString &	accessurl,
		QString *	resource,
		bool	withpath = `false`
	)

static

A utility function for generating a resource from a URL to be compared against the config's uri() for auto-selecting authentication configs to use.

Note: Essentially strips the URL query variables, and by default, strips the path as well

Parameters

accessurl	A URL to process
resource	Ouput variable for result
withpath	Whether to include the URI's path in output

Definition at line 142 of file qgsauthconfig.cpp.

◆ version()

int QgsAuthMethodConfig::version ( ) const

inline

Get version of the configuration.

Definition at line 75 of file qgsauthconfig.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/auth/qgsauthconfig.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/auth/qgsauthconfig.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsAuthMethodConfig()

Member Function Documentation

◆ clearConfigMap()

◆ config()

◆ configList()

◆ configMap()

◆ configString()

◆ hasConfig()

◆ id()

◆ isValid()

◆ loadConfigString()

◆ method()

◆ name()

◆ operator!=()

◆ operator==()

◆ removeConfig()

◆ setConfig()

◆ setConfigList()

◆ setConfigMap()

◆ setId()

◆ setMethod()

◆ setName()

◆ setUri()

◆ setVersion()

◆ uri()

◆ uriToResource()

◆ version()