QGIS API Documentation  3.27.0-Master (0e23467727)
Public Member Functions | Static Public Attributes | List of all members
QgsHttpHeaders Class Reference

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

#include <qgshttpheaders.h>

Public Member Functions

 QgsHttpHeaders ()
 default constructor More...
 
 QgsHttpHeaders (const QDomElement &element)
 Constructor from a QDomElement element. More...
 
 QgsHttpHeaders (const QgsSettings &settings, const QString &key=QString())
 Constructor from QgsSettings settings object and root key. More...
 
 QgsHttpHeaders (const QMap< QString, QVariant > &headers)
 Constructor from map. More...
 
 QgsHttpHeaders (const QString &key)
 Constructor from default QgsSettings object and root key. More...
 
virtual ~QgsHttpHeaders ()
 default detructor More...
 
QList< QString > keys () const
 
QgsHttpHeadersoperator= (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. More...
 
void setFromDomElement (const QDomElement &element)
 Loads headers from the element. More...
 
void setFromMap (const QVariantMap &map)
 Loads headers from the map. More...
 
void setFromSettings (const QgsSettings &settings, const QString &key=QString())
 Loads headers from the settings. More...
 
void setFromUrlQuery (const QUrlQuery &uri)
 Loads headers from the uri. More...
 
QString toSpacedString () const
 Returns key/value pairs as strings separated by space. More...
 
bool updateDomElement (QDomElement &el) const
 Updates a map by adding all the HTTP headers. More...
 
bool updateMap (QVariantMap &map) const
 Updates a map by adding all the HTTP headers. More...
 
bool updateNetworkRequest (QNetworkRequest &request) const
 Updates a request by adding all the HTTP headers. More...
 
bool updateSettings (QgsSettings &settings, const QString &key=QString()) const
 Updates the settings by adding all the http headers in the path "key/PATH_PREFIX/". More...
 
bool updateUrlQuery (QUrlQuery &uri) const
 Updates an uri by adding all the HTTP headers. More...
 

Static Public Attributes

static const QString KEY_REFERER = "referer"
 Used in settings as the referer key. More...
 
static const QString PARAM_PREFIX = "http-header:"
 Used in uri to pass headers as params. More...
 
static const QString PATH_PREFIX = "http-header/"
 Used in settings as the group name. More...
 

Detailed Description

This class implements simple http header management.

Since
QGIS 3.24

Definition at line 38 of file qgshttpheaders.h.

Constructor & Destructor Documentation

◆ QgsHttpHeaders() [1/5]

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

Constructor from map.

Parameters
headers

Definition at line 38 of file qgshttpheaders.cpp.

◆ QgsHttpHeaders() [2/5]

QgsHttpHeaders::QgsHttpHeaders ( )
default

default constructor

◆ QgsHttpHeaders() [3/5]

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

Constructor from QgsSettings settings object and root key.

Parameters
settings
key

Definition at line 44 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 49 of file qgshttpheaders.cpp.

◆ QgsHttpHeaders() [5/5]

QgsHttpHeaders::QgsHttpHeaders ( const QDomElement &  element)

Constructor from a QDomElement element.

Parameters
element

Definition at line 54 of file qgshttpheaders.cpp.

◆ ~QgsHttpHeaders()

QgsHttpHeaders::~QgsHttpHeaders ( )
virtualdefault

default detructor

Member Function Documentation

◆ keys()

QList< QString > QgsHttpHeaders::keys ( ) const
Returns
the list of all http header keys

Definition at line 271 of file qgshttpheaders.cpp.

◆ operator=()

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

Definition at line 265 of file qgshttpheaders.cpp.

◆ operator[]() [1/2]

QVariant & QgsHttpHeaders::operator[] ( const QString &  key)
Parameters
keyhttp header key name
Returns
http header value

Definition at line 255 of file qgshttpheaders.cpp.

◆ operator[]() [2/2]

const QVariant QgsHttpHeaders::operator[] ( const QString &  key) const
Parameters
keyhttp header key name
Returns
http header value

Definition at line 260 of file qgshttpheaders.cpp.

◆ sanitizeKey()

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

Returns a cleansed key.

Parameters
keya key to be sanitized

Definition at line 248 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 209 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 190 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
keysub 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 231 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 122 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 107 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 61 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
keysub group path
Returns
true if the update succeed

Definition at line 79 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 70 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 48 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 51 of file qgshttpheaders.h.

◆ PATH_PREFIX

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

Used in settings as the group name.

Definition at line 45 of file qgshttpheaders.h.


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