requestbuilder.h

#ifndef QTRESTCLIENT_REQUESTBUILDER_H
#define QTRESTCLIENT_REQUESTBUILDER_H
 
#include "QtRestClient/qtrestclient_global.h"
 
#include <QtCore/qcborvalue.h>
#include <QtCore/qjsonvalue.h>
#include <QtCore/qurl.h>
#include <QtCore/qurlquery.h>
#include <QtCore/qversionnumber.h>
#include <QtCore/qshareddata.h>
#include <QtCore/qmimetype.h>
#ifdef QT_RESTCLIENT_USE_ASYNC
#include <QtCore/qfuture.h>
#endif
 
#include <QtNetwork/qnetworkrequest.h>
#include <QtNetwork/qnetworkreply.h>
 
namespace QtRestClient {
 
struct RequestBuilderPrivate;
class Q_RESTCLIENT_EXPORT RequestBuilder
{
public:
    class Q_RESTCLIENT_EXPORT IExtender
    {
        Q_DISABLE_COPY(IExtender)
    public:
        IExtender();
        virtual ~IExtender();
 
        virtual void extendUrl(QUrl &url) const;
        virtual bool requiresBody() const;
        virtual void extendRequest(QNetworkRequest &request, QByteArray &verb, QByteArray *body) const;
    };
 
    RequestBuilder(const QUrl &baseUrl, QNetworkAccessManager *nam = nullptr);
    RequestBuilder(const RequestBuilder &other);
    RequestBuilder(RequestBuilder &&other) noexcept;
    RequestBuilder &operator=(const RequestBuilder &other);
    RequestBuilder &operator=(RequestBuilder &&other) noexcept;
    ~RequestBuilder();
 
    RequestBuilder &setNetworkAccessManager(QNetworkAccessManager *nam);
    RequestBuilder &setExtender(IExtender *extender);
 
    RequestBuilder &setCredentials(QString user, QString password = {});
    RequestBuilder &setVersion(QVersionNumber version);
    RequestBuilder &addPath(const QString &pathSegment);
    RequestBuilder &addPath(const QStringList &pathSegment);
    RequestBuilder &trailingSlash(bool enable = true);
    RequestBuilder &addParameter(const QString &name, const QString &value);
    RequestBuilder &addParameters(const QUrlQuery &parameters);
    RequestBuilder &setFragment(QString fragment);
    RequestBuilder &addHeader(const QByteArray &name, const QByteArray &value);
    RequestBuilder &addHeaders(const HeaderHash &headers);
 
    RequestBuilder &updateFromRelativeUrl(const QUrl &url, bool mergeQuery = false, bool keepFragment = false);
 
    RequestBuilder &setAttribute(QNetworkRequest::Attribute attribute, const QVariant &value);
    RequestBuilder &setAttributes(const QHash<QNetworkRequest::Attribute, QVariant> &attributes);
#ifndef QT_NO_SSL
    RequestBuilder &setSslConfig(QSslConfiguration sslConfig);
#endif
 
    RequestBuilder &setBody(QByteArray body, const QByteArray &contentType, bool setAccept = true);
    RequestBuilder &setBody(QCborValue body, bool setAccept = true);
    RequestBuilder &setBody(const QJsonValue &body, bool setAccept = true);
    RequestBuilder &setVerb(QByteArray verb);
    RequestBuilder &setAccept(const QByteArray &mimeType);
    RequestBuilder &setAccept(const QMimeType &mimeType);
 
    RequestBuilder &addPostParameter(const QString &name, const QString &value);
    RequestBuilder &addPostParameters(const QUrlQuery &parameters);
 
    QUrl buildUrl() const;
    QNetworkRequest build() const;
    QNetworkReply *send() const;
#ifdef QT_RESTCLIENT_USE_ASYNC
    QFuture<QNetworkReply*> sendAsync() const;
#endif
 
private:
    QSharedDataPointer<RequestBuilderPrivate> d;
};
 
}
 
#endif // QTRESTCLIENT_REQUESTBUILDER_H