Class: QgsRequestHandler

This class is an interface hiding the details of reading input and writing output from/to a wms request mechanism.

Methods

appendBody	Sets the info format string such as "text/xml"
body	Returns the response body data
clear	Clears the response body and headers
clearBody	Clear response buffer
data	Returns the request POST data (can be null)
exceptionRaised	Pointer to last raised exception
format	Returns the requested format string
headersSent	Returns True if the HTTP headers were already sent to the client
parameter	Returns a request parameter
parameterMap	Returns the parsed parameters as a key-value pair, to modify a parameter
path	Returns the path component of the request URL
removeParameter	Remove a request parameter
removeRequestHeader	Remove an HTTP request header
removeResponseHeader	Remove an HTTP response header
requestHeader	Retrieve request header value
requestHeaders	Returns the the Request headers
responseHeader	Retrieve response header value
responseHeaders	Returns the response headers
sendResponse	Send out HTTP headers and flush output buffer
setParameter	Sets a request parameter
setRequestHeader	Sets an HTTP request header
setResponseHeader	Sets an HTTP response header
setServiceException	Allow plugins to return a QgsMapServiceException
setStatusCode	Sets response http status code
statusCode	Returns the response http status code
url	Returns the request url

class qgis.server.QgsRequestHandler

Bases: object

__init__(request: QgsServerRequest, response: QgsServerResponse)

Constructor

Note that QgsServerRequest and QgsServerResponse MUST live in the same scope

Parameters:

• request (QgsServerRequest)

• response (QgsServerResponse)

__init__(a0: QgsRequestHandler)

Parameters:

a0 (QgsRequestHandler)

appendBody(self, body: QByteArray | bytes | bytearray)

Sets the info format string such as “text/xml”

Parameters:

body (Union[QByteArray, bytes, bytearray])

body(self) → QByteArray

Returns the response body data

Return type:

QByteArray

clear(self)

Clears the response body and headers

clearBody(self)

Clear response buffer

data(self) → QByteArray

Returns the request POST data (can be null)

Return type:

QByteArray

exceptionRaised(self) → bool

Pointer to last raised exception

Return type:

bool

format(self) → str

Returns the requested format string

Return type:

str

headersSent(self) → bool

Returns True if the HTTP headers were already sent to the client

Return type:

bool

parameter(self, key: str | None) → str

Returns a request parameter

Parameters:

key (Optional[str])

Return type:

str

parameterMap(self) → Dict[str, str]

Returns the parsed parameters as a key-value pair, to modify a parameter

Return type:

Dict[str, str]

QgsRequestHandler.parameterMap( const QString &key, const QString &value) and

parameterMap( const QString &key, const QString &value) and

Return type:

Dict[str, str]

QgsRequestHandler.parameterMap(const QString &key) must be used

parameterMap(const QString &key) must be used

Return type:

Dict[str, str]

path(self) → str

Returns the path component of the request URL

Added in version 3.16.

Return type:

str

removeParameter(self, key: str | None)

Remove a request parameter

Parameters:

key (Optional[str])

removeRequestHeader(self, name: str | None)

Remove an HTTP request header

Parameters:

name (Optional[str])

removeResponseHeader(self, name: str | None)

Remove an HTTP response header

Parameters:

name (Optional[str])

requestHeader(self, name: str | None) → str

Retrieve request header value

Parameters:

name (Optional[str])

Return type:

str

requestHeaders(self) → Dict[str, str]

Returns the the Request headers

Return type:

Dict[str, str]

responseHeader(self, name: str | None) → str

Retrieve response header value

Parameters:

name (Optional[str])

Return type:

str

responseHeaders(self) → Dict[str, str]

Returns the response headers

Return type:

Dict[str, str]

sendResponse(self)

Send out HTTP headers and flush output buffer

This method is intended only for streaming partial content.

setParameter(self, key: str | None, value: str | None)

Sets a request parameter

Parameters:

• key (Optional[str])

• value (Optional[str])

setRequestHeader(self, name: str | None, value: str | None)

Sets an HTTP request header

Parameters:

• name (Optional[str])

• value (Optional[str])

setResponseHeader(self, name: str | None, value: str | None)

Sets an HTTP response header

Parameters:

• name (Optional[str])

• value (Optional[str])

setServiceException(self, ex: QgsServerException)

Allow plugins to return a QgsMapServiceException

Parameters:

ex (QgsServerException)

setStatusCode(self, code: int)

Sets response http status code

Parameters:

code (int)

statusCode(self) → int

Returns the response http status code

Return type:

int

url(self) → str

Returns the request url

Return type:

str