This class implements simple http header management. More...

#include <qgshttpheaders.h>

Public Member Functions
	QgsHttpHeaders ()

	QgsHttpHeaders (const QDomElement &element)
	Constructor from a QDomElement element.

Q_DECL_DEPRECATED	QgsHttpHeaders (const QgsSettings &settings, const QString &key=QString())
	Constructor from QgsSettings settings object and root key.

	QgsHttpHeaders (const QString &key)
	Constructor from default QgsSettings object and root key.

	QgsHttpHeaders (const QVariantMap &headers)
	Constructor from map.

virtual	~QgsHttpHeaders ()
	default detructor

QVariantMap	headers () const
	Returns the headers as a variant map.

void	insert (const QString &key, const QVariant &value)
	insert a key with the specific value

QList< QString >	keys () const

QgsHttpHeaders &	operator= (const QMap< QString, QVariant > &headers)

QVariant &	operator[] (const QString &key)

const QVariant	operator[] (const QString &key) const

QString	sanitizeKey (const QString &key) const
	Returns a cleansed key.

void	setFromDomElement (const QDomElement &element)
	Loads headers from the element.

void	setFromMap (const QVariantMap &map)
	Loads headers from the map.

void	setFromSettings (const QgsSettings &settings, const QString &key=QString())
	Loads headers from the settings.

void	setFromUrlQuery (const QUrlQuery &uri)
	Loads headers from the uri.

QString	toSpacedString () const
	Returns key/value pairs as strings separated by space.

bool	updateDomElement (QDomElement &el) const
	Updates a map by adding all the HTTP headers.

bool	updateMap (QVariantMap &map) const
	Updates a map by adding all the HTTP headers.

bool	updateNetworkRequest (QNetworkRequest &request) const
	Updates a request by adding all the HTTP headers.

Q_DECL_DEPRECATED bool	updateSettings (QgsSettings &settings, const QString &key=QString()) const
	Updates the settings by adding all the http headers in the path "key/PATH_PREFIX/".

bool	updateUrlQuery (QUrlQuery &uri) const
	Updates an uri by adding all the HTTP headers.

Static Public Attributes
static const QString	KEY_REFERER = "referer"
	Used in settings as the referer key.

static const QString	PARAM_PREFIX = "http-header:"
	Used in uri to pass headers as params.

static const QString	PATH_PREFIX = "http-header/"
	Used in settings as the group name.

Detailed Description

This class implements simple http header management.

Since: QGIS 3.24

Definition at line 41 of file qgshttpheaders.h.

Constructor & Destructor Documentation

◆ QgsHttpHeaders() [1/5]

QgsHttpHeaders::QgsHttpHeaders ( const QVariantMap & headers )

Constructor from map.

Parameters

headers

Definition at line 40 of file qgshttpheaders.cpp.

◆ QgsHttpHeaders() [2/5]

QgsHttpHeaders::QgsHttpHeaders ( )

default

◆ QgsHttpHeaders() [3/5]

QgsHttpHeaders::QgsHttpHeaders	(	const QgsSettings &	settings,
		const QString &	key = `QString()`
	)

Constructor from QgsSettings settings object and root key.

Parameters

settings
key

Deprecated:: QGIS 3.30. Use a variant map settings and the default constructor instead.

Definition at line 46 of file qgshttpheaders.cpp.

◆ QgsHttpHeaders() [4/5]

QgsHttpHeaders::QgsHttpHeaders ( const QString & key )

Constructor from default QgsSettings object and root key.

Parameters

key

Definition at line 51 of file qgshttpheaders.cpp.

◆ QgsHttpHeaders() [5/5]

QgsHttpHeaders::QgsHttpHeaders ( const QDomElement & element )

Constructor from a QDomElement element.

Parameters

element

Definition at line 56 of file qgshttpheaders.cpp.

◆ ~QgsHttpHeaders()

QgsHttpHeaders::~QgsHttpHeaders ( )

virtualdefault

default detructor

Member Function Documentation

◆ headers()

QVariantMap QgsHttpHeaders::headers ( ) const

inline

Returns the headers as a variant map.

Since: QGIS 3.30

Definition at line 93 of file qgshttpheaders.h.

◆ insert()

void QgsHttpHeaders::insert	(	const QString &	key,
		const QVariant &	value
	)

insert a key with the specific value

Parameters

key	a key to add
value	a value to add for the key

Definition at line 281 of file qgshttpheaders.cpp.

◆ keys()

QList< QString > QgsHttpHeaders::keys ( ) const

Returns: the list of all http header keys

Definition at line 275 of file qgshttpheaders.cpp.

◆ operator=()

QgsHttpHeaders & QgsHttpHeaders::operator= ( const QMap< QString, QVariant > & headers )

Definition at line 269 of file qgshttpheaders.cpp.

◆ operator[]() [1/2]

QVariant & QgsHttpHeaders::operator[] ( const QString & key )

Parameters

key	http header key name

Returns: http header value

Definition at line 259 of file qgshttpheaders.cpp.

◆ operator[]() [2/2]

const QVariant QgsHttpHeaders::operator[] ( const QString & key ) const

Parameters

key	http header key name

Returns: http header value

Definition at line 264 of file qgshttpheaders.cpp.

◆ sanitizeKey()

QString QgsHttpHeaders::sanitizeKey ( const QString & key ) const

Returns a cleansed key.

Parameters

key	a key to be sanitized

Definition at line 252 of file qgshttpheaders.cpp.

◆ setFromDomElement()

void QgsHttpHeaders::setFromDomElement ( const QDomElement & element )

Loads headers from the element.

key KEY_REFERER will be read from attribute "KEY_PREFIX+KEY_REFERER" and attribute "KEY_REFERER" (for backward compatibility)

Parameters

element

Definition at line 213 of file qgshttpheaders.cpp.

◆ setFromMap()

void QgsHttpHeaders::setFromMap ( const QVariantMap & map )

Loads headers from the map.

key KEY_REFERER will be read from key "KEY_PREFIX+KEY_REFERER" and key "KEY_REFERER" (for backward compatibility)

Parameters

map

Definition at line 194 of file qgshttpheaders.cpp.

◆ setFromSettings()

void QgsHttpHeaders::setFromSettings	(	const QgsSettings &	settings,
		const QString &	key = `QString()`
	)

Loads headers from the settings.

key KEY_REFERER will be read at path "key/PATH_PREFIX/KEY_REFERER" and path "key/KEY_REFERER" (for backward compatibility)

Parameters

settings
key	sub group path

Definition at line 140 of file qgshttpheaders.cpp.

◆ setFromUrlQuery()

void QgsHttpHeaders::setFromUrlQuery ( const QUrlQuery & uri )

Loads headers from the uri.

Parameters

uri

Definition at line 176 of file qgshttpheaders.cpp.

◆ toSpacedString()

QString QgsHttpHeaders::toSpacedString ( ) const

Returns key/value pairs as strings separated by space.

Definition at line 235 of file qgshttpheaders.cpp.

◆ updateDomElement()

bool QgsHttpHeaders::updateDomElement ( QDomElement & el ) const

Updates a map by adding all the HTTP headers.

KEY_REFERER value will be available at attribute "KEY_PREFIX+KEY_REFERER" and attribute "KEY_REFERER" (for backward compatibility)

Returns: true if the update succeed

Definition at line 124 of file qgshttpheaders.cpp.

◆ updateMap()

bool QgsHttpHeaders::updateMap ( QVariantMap & map ) const

Updates a map by adding all the HTTP headers.

KEY_REFERER value will be available at key "KEY_PREFIX+KEY_REFERER" and key "KEY_REFERER" (for backward compatibility)

Returns: true if the update succeed

Definition at line 109 of file qgshttpheaders.cpp.

◆ updateNetworkRequest()

bool QgsHttpHeaders::updateNetworkRequest ( QNetworkRequest & request ) const

Updates a request by adding all the HTTP headers.

Returns: true if the update succeed

Definition at line 63 of file qgshttpheaders.cpp.

◆ updateSettings()

bool QgsHttpHeaders::updateSettings	(	QgsSettings &	settings,
		const QString &	key = `QString()`
	)		const

Updates the settings by adding all the http headers in the path "key/PATH_PREFIX/".

KEY_REFERER value will be available at path "key/PATH_PREFIX/KEY_REFERER" and path "key/KEY_REFERER" (for backward compatibility)

Parameters

settings
key	sub group path

Returns: true if the update succeed

Deprecated:: QGIS 3.30. Directly use a variant setting instead.

Definition at line 81 of file qgshttpheaders.cpp.

◆ updateUrlQuery()

bool QgsHttpHeaders::updateUrlQuery ( QUrlQuery & uri ) const

Updates an uri by adding all the HTTP headers.

Returns: true if the update succeed

Definition at line 72 of file qgshttpheaders.cpp.

Member Data Documentation

◆ KEY_REFERER

const QString QgsHttpHeaders::KEY_REFERER = "referer"

static

Used in settings as the referer key.

Definition at line 51 of file qgshttpheaders.h.

◆ PARAM_PREFIX

const QString QgsHttpHeaders::PARAM_PREFIX = "http-header:"

static

Used in uri to pass headers as params.

Definition at line 54 of file qgshttpheaders.h.

◆ PATH_PREFIX

const QString QgsHttpHeaders::PATH_PREFIX = "http-header/"

static

Used in settings as the group name.

Definition at line 48 of file qgshttpheaders.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/network/qgshttpheaders.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/network/qgshttpheaders.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsHttpHeaders() [1/5]

◆ QgsHttpHeaders() [2/5]

◆ QgsHttpHeaders() [3/5]

◆ QgsHttpHeaders() [4/5]

◆ QgsHttpHeaders() [5/5]

◆ ~QgsHttpHeaders()

Member Function Documentation

◆ headers()

◆ insert()

◆ keys()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ sanitizeKey()

◆ setFromDomElement()

◆ setFromMap()

◆ setFromSettings()

◆ setFromUrlQuery()

◆ toSpacedString()

◆ updateDomElement()

◆ updateMap()

◆ updateNetworkRequest()

◆ updateSettings()

◆ updateUrlQuery()

Member Data Documentation

◆ KEY_REFERER

◆ PARAM_PREFIX

◆ PATH_PREFIX