Class defining request interface passed to WMS service. More...
#include <qgswmsrequest.h>
Inheritance diagram for QgsWms::QgsWmsRequest:
Public Member Functions | |
| QgsWmsRequest (const QgsServerRequest &other) | |
| Copy constructor. More... | |
| ~QgsWmsRequest () override=default | |
| Destructor. More... | |
| void | removeParameter (const QString &key) override |
| Remove a parameter. More... | |
| void | setParameter (const QString &key, const QString &value) override |
| Set a parameter. More... | |
| void | setUrl (const QUrl &url) override |
| Set the request url. More... | |
| const QgsWmsParameters & | wmsParameters () const |
| Returns the parameters interpreted for the WMS service. More... | |
 Public Member Functions inherited from QgsServerRequest | |
| QgsServerRequest ()=default | |
| Constructor. More... | |
| QgsServerRequest (const QgsServerRequest &other) | |
| Copy constructor. More... | |
| QgsServerRequest (const QString &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers()) | |
| Constructor. More... | |
| QgsServerRequest (const QUrl &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers()) | |
| Constructor. More... | |
| virtual | ~QgsServerRequest ()=default |
| destructor More... | |
| QUrl | baseUrl () const |
| Returns the base URL of QGIS server. More... | |
| virtual QByteArray | data () const |
| Returns post/put data Check for QByteArray::isNull() to check if data is available. More... | |
| virtual QString | header (const QString &name) const |
| Returns the header value. More... | |
| virtual QString | header (const RequestHeader &headerEnum) const |
| Returns the header value. More... | |
| QMap< QString, QString > | headers () const |
| Returns the header map. More... | |
| QgsServerRequest::Method | method () const |
| QgsServerRequest & | operator= (const QgsServerRequest &)=default |
| QUrl | originalUrl () const |
| Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server. More... | |
| QString | parameter (const QString &key, const QString &defaultValue=QString()) const |
| Gets a parameter value. More... | |
| QgsServerRequest::Parameters | parameters () const |
| Returns a map of query parameters with keys converted to uppercase. More... | |
| const QString | queryParameter (const QString &name, const QString &defaultValue=QString()) const |
| Returns the query string parameter with the given name from the request URL, a defaultValue can be specified. More... | |
| void | removeHeader (const QString &name) |
| Remove an header. More... | |
| virtual void | removeParameter (const QString &key) |
| Remove a parameter. More... | |
| QgsServerParameters | serverParameters () const |
| Returns parameters. More... | |
| void | setHeader (const QString &name, const QString &value) |
| Set an header. More... | |
| void | setMethod (QgsServerRequest::Method method) |
| Set the request method. More... | |
| virtual void | setParameter (const QString &key, const QString &value) |
| Set a parameter. More... | |
| virtual void | setUrl (const QUrl &url) |
| Set the request url. More... | |
| QUrl | url () const |
Additional Inherited Members | |
| Public Types inherited from QgsServerRequest | |
| typedef QMap< QString, QString > | Headers |
| enum | Method { HeadMethod , PutMethod , GetMethod , PostMethod , DeleteMethod , PatchMethod } |
| HTTP Method (or equivalent) used for the request. More... | |
| typedef QMap< QString, QString > | Parameters |
| enum | RequestHeader { HOST , FORWARDED , X_FORWARDED_FOR , X_FORWARDED_HOST , X_FORWARDED_PROTO , X_QGIS_SERVICE_URL , X_QGIS_WMS_SERVICE_URL , X_QGIS_WFS_SERVICE_URL , X_QGIS_WCS_SERVICE_URL , X_QGIS_WMTS_SERVICE_URL , ACCEPT , USER_AGENT , AUTHORIZATION } |
| The internal HTTP Header used for the request as enum. More... | |
| Static Public Member Functions inherited from QgsServerRequest | |
| static QString | methodToString (const Method &method) |
| Returns a string representation of an HTTP request method. More... | |
| Protected Member Functions inherited from QgsServerRequest | |
| void | setBaseUrl (const QUrl &url) |
| Set the base URL of QGIS server. More... | |
| void | setOriginalUrl (const QUrl &url) |
| Set the request original url (the request url as seen by the web server) More... | |
Detailed Description
Class defining request interface passed to WMS service.
- Since
- QGIS 3.20
Definition at line 34 of file qgswmsrequest.h.
Constructor & Destructor Documentation
◆ QgsWmsRequest()
| QgsWms::QgsWmsRequest::QgsWmsRequest | ( | const QgsServerRequest & | other | ) |
Copy constructor.
Definition at line 24 of file qgswmsrequest.cpp.
◆ ~QgsWmsRequest()
|
overridedefault |
Destructor.
Member Function Documentation
◆ removeParameter()
|
overridevirtual |
Remove a parameter.
Reimplemented from QgsServerRequest.
Definition at line 41 of file qgswmsrequest.cpp.
◆ setParameter()
|
overridevirtual |
Set a parameter.
Reimplemented from QgsServerRequest.
Definition at line 35 of file qgswmsrequest.cpp.
◆ setUrl()
|
overridevirtual |
Set the request url.
Reimplemented from QgsServerRequest.
Definition at line 47 of file qgswmsrequest.cpp.
◆ wmsParameters()
| const QgsWmsParameters & QgsWms::QgsWmsRequest::wmsParameters | ( | ) | const |
Returns the parameters interpreted for the WMS service.
Definition at line 30 of file qgswmsrequest.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/server/services/wms/qgswmsrequest.h
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/server/services/wms/qgswmsrequest.cpp
