Class: QgsServerRequest¶

Defines requests passed to QgsService classes.

List of all members, including inherited members

Class Hierarchy¶

Subclasses¶

`QgsBufferServerRequest`	Defines a request with data.
`QgsFcgiServerRequest`	Defines fcgi requests.

Enums

`Method`
`RequestHeader`

Methods

`baseUrl`	Returns the base URL of QGIS server
`headers`	Returns the header map
`method`	Returns the request method.
`originalUrl`	Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server
`parameter`	Gets a parameter value
`parameters`	Returns a map of query parameters with keys converted to uppercase
`queryParameter`	Returns the query string parameter with the given name from the request URL, a defaultValue can be specified.
`removeHeader`	Remove an header
`serverParameters`	Returns parameters
`setBaseUrl`	Set the base URL of QGIS server
`setHeader`	Set an header
`setMethod`	Set the request method
`setOriginalUrl`	Set the request original url (the request url as seen by the web server)
`url`	Returns the request URL as seen by QGIS server.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsServerRequest. See the FAQ for more details.

`data`	available.
`header`	Returns the header value
`removeParameter`	Remove a parameter
`setParameter`	Set a parameter
`setUrl`	Set the request url

Static Methods

methodToString

Returns a string representation of an HTTP request method.

class qgis.server.QgsServerRequest[source]¶

Bases: object

__init__()

__init__(url: str | None, method: QgsServerRequest.Method = QgsServerRequest.GetMethod, headers: dict[str | None, str | None] = {})

Constructor

Parameters:

url (Optional[str]) – the url string
method (QgsServerRequest.Method = QgsServerRequest.GetMethod) – the request method
headers (dict[Optional[str], Optional[str]] = {})

__init__(url: QUrl, method: QgsServerRequest.Method = QgsServerRequest.GetMethod, headers: dict[str | None, str | None] = {})

Constructor

Parameters:

url (QUrl) – QUrl
method (QgsServerRequest.Method = QgsServerRequest.GetMethod) – the request method
headers (dict[Optional[str], Optional[str]] = {})

__init__(other: QgsServerRequest)

Parameters:: other (QgsServerRequest)

ACCEPT = 10¶

AUTHORIZATION = 12¶

DeleteMethod = 4¶

FORWARDED = 1¶

GetMethod = 2¶

HOST = 0¶

HeadMethod = 0¶

class Method(*values)¶

Bases: IntEnum

DeleteMethod = 4¶

GetMethod = 2¶

HeadMethod = 0¶

PatchMethod = 5¶

PostMethod = 3¶

PutMethod = 1¶

PatchMethod = 5¶

PostMethod = 3¶

PutMethod = 1¶

class RequestHeader(*values)¶

Bases: IntEnum

ACCEPT = 10¶

AUTHORIZATION = 12¶

FORWARDED = 1¶

HOST = 0¶

USER_AGENT = 11¶

X_FORWARDED_FOR = 2¶

X_FORWARDED_HOST = 3¶

X_FORWARDED_PROTO = 4¶

X_QGIS_SERVICE_URL = 5¶

X_QGIS_WCS_SERVICE_URL = 8¶

X_QGIS_WFS_SERVICE_URL = 7¶

X_QGIS_WMS_SERVICE_URL = 6¶

X_QGIS_WMTS_SERVICE_URL = 9¶

USER_AGENT = 11¶

X_FORWARDED_FOR = 2¶

X_FORWARDED_HOST = 3¶

X_FORWARDED_PROTO = 4¶

X_QGIS_SERVICE_URL = 5¶

X_QGIS_WCS_SERVICE_URL = 8¶

X_QGIS_WFS_SERVICE_URL = 7¶

X_QGIS_WMS_SERVICE_URL = 6¶

X_QGIS_WMTS_SERVICE_URL = 9¶

baseUrl(self) → QUrl[source]¶

Returns the base URL of QGIS server

E.g. if we call QGIS server with http://example.com/folder?REQUEST=WMS&... the base URL will be http://example.com/folder

Added in version 3.20.

Return type:: QUrl

virtual data(self) → QByteArray[source]¶: available.

virtual header(self, name: str | None) → str[source]¶

Returns the header value

Parameters:: name (Optional[str]) – of the header
Returns:: the header value or an empty string

header(self, headerEnum: QgsServerRequest.RequestHeader) -> str Returns the header value

Parameters:: headerEnum – of the header
Return type:: str
Returns:: the header value or an empty string

headers(self) → dict[str, str]¶

Returns the header map

Return type:: dict[str, str]
Returns:: the headers map

method(self) → QgsServerRequest.Method[source]¶

Returns the request method.

Return type:: QgsServerRequest.Method

static methodToString(method: QgsServerRequest.Method) → str[source]¶

Returns a string representation of an HTTP request method.

Added in version 3.12.

Parameters:: method (QgsServerRequest.Method)
Return type:: str

originalUrl(self) → QUrl[source]¶

Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server