An interface hiding the details of reading input and writing output from/to a wms request mechanism. More...

#include <qgsrequesthandler.h>

Public Member Functions
	QgsRequestHandler (QgsServerRequest &request, QgsServerResponse &response)
	Constructor.
void	appendBody (const QByteArray &body)
	Sets the info format string such as "text/xml".
QByteArray	body () const
	Returns the response body data.
void	clear ()
	Clears the response body and headers.
void	clearBody ()
	Clear response buffer.
QByteArray	data () const
	Returns the request POST data (can be null).
bool	exceptionRaised () const
	Pointer to last raised exception.
QString	format () const
	Returns the requested format string.
QList< QString >	fullResponseHeader (const QString &name) const
	Returns the list of response headers for a given header name.
QMap< QString, QList< QString > >	fullResponseHeaders () const
	Returns the response headers as a map of header name to list of values (to support multiple values for the same header).
bool	headersSent () const
	Returns `true` if the HTTP headers were already sent to the client.
QString	parameter (const QString &key) const
	Returns a request parameter.
QMap< QString, QString >	parameterMap () const
	Returns the parsed parameters as a key-value pair.
void	parseInput ()
	Parses the input and creates a request neutral Parameter/Value map.
QString	path () const
	Returns the path component of the request URL.
void	removeParameter (const QString &key)
	Remove a request parameter.
void	removeRequestHeader (const QString &name)
	Remove an HTTP request header.
void	removeResponseHeader (const QString &name)
	Remove an HTTP response header.
QString	requestHeader (const QString &name) const
	Retrieve request header value.
QMap< QString, QString >	requestHeaders () const
	Returns the Request headers.
QString	responseHeader (const QString &name) const
	Retrieve response header value.
Q_DECL_DEPRECATED QMap< QString, QString >	responseHeaders () const
	Returns the response headers: note that if multiple values are set for the same header, only the last one is returned.
void	sendResponse ()
	Send out HTTP headers and flush output buffer.
void	setParameter (const QString &key, const QString &value)
	Sets a request parameter.
void	setRequestHeader (const QString &name, const QString &value)
	Sets an HTTP request header.
void	setResponseHeader (const QString &name, const QString &value)
	Sets an HTTP response header.
void	setServiceException (const QgsServerException &ex)
	Allow plugins to return a QgsMapServiceException.
void	setStatusCode (int code)
	Sets response http status code.
int	statusCode () const
	Returns the response http status code.
QString	url () const
	Returns the request url.

Detailed Description

An interface hiding the details of reading input and writing output from/to a wms request mechanism.

Definition at line 38 of file qgsrequesthandler.h.

Constructor & Destructor Documentation

◆ QgsRequestHandler()

QgsRequestHandler::QgsRequestHandler	(	QgsServerRequest &	request,
		QgsServerResponse &	response )

explicit

Constructor.

Note that QgsServerRequest and QgsServerResponse MUST live in the same scope

Definition at line 35 of file qgsrequesthandler.cpp.

Member Function Documentation

◆ appendBody()

void QgsRequestHandler::appendBody ( const QByteArray & body )

Sets the info format string such as "text/xml".

Definition at line 116 of file qgsrequesthandler.cpp.

◆ body()

QByteArray QgsRequestHandler::body ( ) const

Returns the response body data.

Definition at line 126 of file qgsrequesthandler.cpp.

◆ clear()

void QgsRequestHandler::clear ( )

Clears the response body and headers.

Definition at line 55 of file qgsrequesthandler.cpp.

◆ clearBody()

void QgsRequestHandler::clearBody ( )

Clear response buffer.

Definition at line 121 of file qgsrequesthandler.cpp.

◆ data()

QByteArray QgsRequestHandler::data ( ) const

Returns the request POST data (can be null).

Definition at line 131 of file qgsrequesthandler.cpp.

◆ exceptionRaised()

bool QgsRequestHandler::exceptionRaised ( ) const

Pointer to last raised exception.

Definition at line 45 of file qgsrequesthandler.cpp.

◆ format()

QString QgsRequestHandler::format ( ) const

inline

Returns the requested format string.

Definition at line 155 of file qgsrequesthandler.h.

◆ fullResponseHeader()

QList< QString > QgsRequestHandler::fullResponseHeader ( const QString & name ) const

Returns the list of response headers for a given header name.

Since: QGIS 4.2

Definition at line 79 of file qgsrequesthandler.cpp.

◆ fullResponseHeaders()

QMap< QString, QList< QString > > QgsRequestHandler::fullResponseHeaders ( ) const

Returns the response headers as a map of header name to list of values (to support multiple values for the same header).

Since: QGIS 4.2

Definition at line 84 of file qgsrequesthandler.cpp.

◆ headersSent()

bool QgsRequestHandler::headersSent ( ) const

Returns true if the HTTP headers were already sent to the client.

Definition at line 111 of file qgsrequesthandler.cpp.

◆ parameter()

QString QgsRequestHandler::parameter ( const QString & key ) const

Returns a request parameter.

Definition at line 293 of file qgsrequesthandler.cpp.

◆ parameterMap()

QMap< QString, QString > QgsRequestHandler::parameterMap ( ) const

Returns the parsed parameters as a key-value pair.

See also: setParameter(); removeParameter()

Definition at line 40 of file qgsrequesthandler.cpp.

◆ parseInput()

void QgsRequestHandler::parseInput ( )

Parses the input and creates a request neutral Parameter/Value map.

Note: not available in Python bindings

Definition at line 208 of file qgsrequesthandler.cpp.

◆ path()

QString QgsRequestHandler::path ( ) const

Returns the path component of the request URL.

Since: QGIS 3.16

Definition at line 141 of file qgsrequesthandler.cpp.

◆ removeParameter()

void QgsRequestHandler::removeParameter ( const QString & key )

Remove a request parameter.

Definition at line 298 of file qgsrequesthandler.cpp.

◆ removeRequestHeader()

void QgsRequestHandler::removeRequestHeader ( const QString & name )

Remove an HTTP request header.

Definition at line 94 of file qgsrequesthandler.cpp.

◆ removeResponseHeader()

void QgsRequestHandler::removeResponseHeader ( const QString & name )

Remove an HTTP response header.

Definition at line 60 of file qgsrequesthandler.cpp.

◆ requestHeader()

QString QgsRequestHandler::requestHeader ( const QString & name ) const

Retrieve request header value.

Definition at line 99 of file qgsrequesthandler.cpp.

◆ requestHeaders()

QMap< QString, QString > QgsRequestHandler::requestHeaders ( ) const

Returns the Request headers.

Definition at line 105 of file qgsrequesthandler.cpp.

◆ responseHeader()

QString QgsRequestHandler::responseHeader ( const QString & name ) const

Retrieve response header value.

Definition at line 65 of file qgsrequesthandler.cpp.

◆ responseHeaders()

QMap< QString, QString > QgsRequestHandler::responseHeaders ( ) const

Returns the response headers: note that if multiple values are set for the same header, only the last one is returned.

Deprecated: QGIS 4.2. Use fullResponseHeaders() instead.

Definition at line 72 of file qgsrequesthandler.cpp.

◆ sendResponse()

void QgsRequestHandler::sendResponse ( )

Send out HTTP headers and flush output buffer.

This method is intended only for streaming partial content.

Definition at line 156 of file qgsrequesthandler.cpp.

◆ setParameter()

void QgsRequestHandler::setParameter	(	const QString &	key,
		const QString &	value )

Sets a request parameter.

Definition at line 278 of file qgsrequesthandler.cpp.

◆ setRequestHeader()

void QgsRequestHandler::setRequestHeader	(	const QString &	name,
		const QString &	value )

Sets an HTTP request header.

Definition at line 89 of file qgsrequesthandler.cpp.

◆ setResponseHeader()

void QgsRequestHandler::setResponseHeader	(	const QString &	name,
		const QString &	value )

Sets an HTTP response header.

Definition at line 50 of file qgsrequesthandler.cpp.

◆ setServiceException()

void QgsRequestHandler::setServiceException ( const QgsServerException & ex )

Allow plugins to return a QgsMapServiceException.

Definition at line 162 of file qgsrequesthandler.cpp.

◆ setStatusCode()

void QgsRequestHandler::setStatusCode ( int code )

Sets response http status code.

Definition at line 146 of file qgsrequesthandler.cpp.

◆ statusCode()

int QgsRequestHandler::statusCode ( ) const

Returns the response http status code.

Definition at line 151 of file qgsrequesthandler.cpp.

◆ url()

QString QgsRequestHandler::url ( ) const

Returns the request url.

Definition at line 136 of file qgsrequesthandler.cpp.

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

/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/server/qgsrequesthandler.h
/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/server/qgsrequesthandler.cpp

Public Member Functions