|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
This class is 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. More... | |
| void | appendBody (const QByteArray &body) |
| Sets the info format string such as "text/xml". More... | |
| QByteArray | body () const |
| Returns the response body data. More... | |
| void | clear () |
| Clears the response body and headers. More... | |
| void | clearBody () |
| Clear response buffer. More... | |
| QByteArray | data () const |
| Returns the request POST data (can be null) More... | |
| bool | exceptionRaised () const |
| Pointer to last raised exception. More... | |
| QString | format () const |
| Returns the requested format string. More... | |
| bool | headersSent () const |
| Returns true if the HTTP headers were already sent to the client. More... | |
| QString | parameter (const QString &key) const |
| Returns a request parameter. More... | |
| QMap< QString, QString > | parameterMap () const |
| Returns the parsed parameters as a key-value pair, to modify a parameter setParameter( const QString &key, const QString &value) and removeParameter(const QString &key) must be used. More... | |
| void | parseInput () |
| Parses the input and creates a request neutral Parameter/Value map. More... | |
| void | removeParameter (const QString &key) |
| Remove a request parameter. More... | |
| void | removeRequestHeader (const QString &name) |
| Remove an HTTP request header. More... | |
| void | removeResponseHeader (const QString &name) |
| Remove an HTTP response header. More... | |
| QString | requestHeader (const QString &name) const |
| Retrieve request header value. More... | |
| QMap< QString, QString > | requestHeaders () const |
| Returns the the Request headers. More... | |
| QString | responseHeader (const QString &name) const |
| Retrieve response header value. More... | |
| QMap< QString, QString > | responseHeaders () const |
| Returns the response headers. More... | |
| void | sendResponse () |
| Send out HTTP headers and flush output buffer. More... | |
| void | setParameter (const QString &key, const QString &value) |
| Sets a request parameter. More... | |
| void | setRequestHeader (const QString &name, const QString &value) |
| Sets an HTTP request header. More... | |
| void | setResponseHeader (const QString &name, const QString &value) |
| Sets an HTTP response header. More... | |
| void | setServiceException (const QgsServerException &ex) |
| Allow plugins to return a QgsMapServiceException. More... | |
| void | setStatusCode (int code) |
| Sets response http status code. More... | |
| int | statusCode () const |
| Returns the response http status code. More... | |
| QString | url () const |
| Returns the request url. More... | |
This class is an interface hiding the details of reading input and writing output from/to a wms request mechanism.
Definition at line 47 of file qgsrequesthandler.h.
|
explicit |
Constructor.
Note that QgsServerRequest and QgsServerResponse MUST live in the same scope
Definition at line 36 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::appendBody | ( | const QByteArray & | body | ) |
Sets the info format string such as "text/xml".
Definition at line 105 of file qgsrequesthandler.cpp.
| QByteArray QgsRequestHandler::body | ( | ) | const |
Returns the response body data.
Definition at line 115 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::clear | ( | ) |
Clears the response body and headers.
Definition at line 58 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::clearBody | ( | ) |
Clear response buffer.
Definition at line 110 of file qgsrequesthandler.cpp.
| QByteArray QgsRequestHandler::data | ( | ) | const |
Returns the request POST data (can be null)
Definition at line 120 of file qgsrequesthandler.cpp.
| bool QgsRequestHandler::exceptionRaised | ( | ) | const |
Pointer to last raised exception.
Definition at line 48 of file qgsrequesthandler.cpp.
|
inline |
Returns the requested format string.
Definition at line 143 of file qgsrequesthandler.h.
| bool QgsRequestHandler::headersSent | ( | ) | const |
Returns true if the HTTP headers were already sent to the client.
Definition at line 100 of file qgsrequesthandler.cpp.
| QString QgsRequestHandler::parameter | ( | const QString & | key | ) | const |
Returns a request parameter.
Definition at line 280 of file qgsrequesthandler.cpp.
| QMap< QString, QString > QgsRequestHandler::parameterMap | ( | ) | const |
Returns the parsed parameters as a key-value pair, to modify a parameter setParameter( const QString &key, const QString &value) and removeParameter(const QString &key) must be used.
Definition at line 43 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::parseInput | ( | ) |
Parses the input and creates a request neutral Parameter/Value map.
Definition at line 196 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::removeParameter | ( | const QString & | key | ) |
Remove a request parameter.
Definition at line 285 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::removeRequestHeader | ( | const QString & | name | ) |
Remove an HTTP request header.
Definition at line 83 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::removeResponseHeader | ( | const QString & | name | ) |
Remove an HTTP response header.
Definition at line 63 of file qgsrequesthandler.cpp.
| QString QgsRequestHandler::requestHeader | ( | const QString & | name | ) | const |
Retrieve request header value.
Definition at line 88 of file qgsrequesthandler.cpp.
| QMap< QString, QString > QgsRequestHandler::requestHeaders | ( | ) | const |
Returns the the Request headers.
Definition at line 94 of file qgsrequesthandler.cpp.
| QString QgsRequestHandler::responseHeader | ( | const QString & | name | ) | const |
Retrieve response header value.
Definition at line 68 of file qgsrequesthandler.cpp.
| QMap< QString, QString > QgsRequestHandler::responseHeaders | ( | ) | const |
Returns the response headers.
Definition at line 73 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::sendResponse | ( | ) |
Send out HTTP headers and flush output buffer.
This method is intended only for streaming partial content.
Definition at line 140 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::setParameter | ( | const QString & | key, |
| const QString & | value | ||
| ) |
Sets a request parameter.
Definition at line 264 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::setRequestHeader | ( | const QString & | name, |
| const QString & | value | ||
| ) |
Sets an HTTP request header.
Definition at line 78 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::setResponseHeader | ( | const QString & | name, |
| const QString & | value | ||
| ) |
Sets an HTTP response header.
Definition at line 53 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::setServiceException | ( | const QgsServerException & | ex | ) |
Allow plugins to return a QgsMapServiceException.
Definition at line 146 of file qgsrequesthandler.cpp.
| void QgsRequestHandler::setStatusCode | ( | int | code | ) |
Sets response http status code.
Definition at line 130 of file qgsrequesthandler.cpp.
| int QgsRequestHandler::statusCode | ( | ) | const |
Returns the response http status code.
Definition at line 135 of file qgsrequesthandler.cpp.
| QString QgsRequestHandler::url | ( | ) | const |
Returns the request url.
Definition at line 125 of file qgsrequesthandler.cpp.
1.8.11
