10Duke Enterprise C++ SDK
Loading...
Searching...
No Matches
HTTPRequestBuilder.h
1#ifndef TENDUKE_HTTP_HTTPREQUESTBUILDER_H
2#define TENDUKE_HTTP_HTTPREQUESTBUILDER_H
3
4#include "./HTTPRequest.h"
5#include "./HTTPRequestAuthenticator.h"
6#include "net/URL.h"
7#include "net/URLBuilder.h"
8#include "net/URLs.h"
9
10#include <string>
11#include <memory>
12#include <map>
13
14namespace tenduke { namespace http {
15
16class HTTPCall;
17class HTTPClient;
18
23{
24public:
32 explicit HTTPRequestBuilder(
33 const ::tenduke::net::URLs &urls,
34 tenduke::http::HTTPClient * client = nullptr,
35 long connectionTimeoutMs = tenduke::http::DEFAULT_CONNECTION_TIMEOUT_MS,
37 );
38
43 std::unique_ptr<HTTPRequest> build();
44
53 std::unique_ptr<HTTPCall> call();
54
60
66
73 HTTPRequestBuilder & url(const std::string &url);
74
80 HTTPRequestBuilder & url(const ::tenduke::net::URL &url);
81
87 HTTPRequestBuilder & authenticateWith(const std::shared_ptr<const tenduke::http::HTTPRequestAuthenticator> &requestAuthenticator);
88
98 HTTPRequestBuilder & header(const std::string &name, const std::string &value, bool skipIfValueEmpty = true);
99
106 HTTPRequestBuilder & formParameter(const std::string &name, const std::string &value);
107
113 HTTPRequestBuilder & contentType(const std::string &contentType);
114
120 HTTPRequestBuilder & charset(const std::string &charset);
121
128
134 HTTPRequestBuilder & body(const std::string &requestEntity);
135
141
147 ::tenduke::net::URLBuilder createURL(const ::tenduke::net::URL &url) const;
148
154 ::tenduke::net::URLBuilder createURL(const std::string &url) const;
155
156protected:
161
162private:
163 const tenduke::http::HTTPClient * client;
164
165 std::string method;
166 std::string requestEntity; // aka body
168 std::shared_ptr<const tenduke::http::HTTPRequestAuthenticator> requestAuthenticator;
169 std::multimap<std::string, std::string> headers;
170 std::multimap<std::string, std::string> formParameters;
171 std::string requestContentType;
172 std::string requestCharset;
173
174 long connectionTimeoutMs;
175 long timeoutMs;
176
177 const ::tenduke::net::URLs &urls;
178};
179
180
181}}
182
183#endif // TENDUKE_HTTP_HTTPREQUESTBUILDER_H
HTTPRequestBuilder & contentType(const std::string &contentType)
Sets content-type.
Definition HTTPRequestBuilder.cpp:143
HTTPRequestBuilder & charset(const std::string &charset)
Sets character set.
Definition HTTPRequestBuilder.cpp:149
HTTPRequestBuilder(const ::tenduke::net::URLs &urls, tenduke::http::HTTPClient *client=nullptr, long connectionTimeoutMs=tenduke::http::DEFAULT_CONNECTION_TIMEOUT_MS, long timeoutMs=tenduke::http::DEFAULT_TIMEOUT_MS)
Constructs new instance.
Definition HTTPRequestBuilder.cpp:16
HTTPRequestBuilder & url(const std::string &url)
Sets the request URL.
Definition HTTPRequestBuilder.cpp:97
HTTP-call which executes the request and returns HTTPResponse.
Definition HTTPCall.h:15
A simple HTTP-client.
Definition HTTPClient.h:19
HTTPRequestBuilder & get()
Sets the method to GET.
Definition HTTPRequestBuilder.cpp:85
HTTPRequestBuilder & body(const std::string &requestEntity)
Sets body as string.
Definition HTTPRequestBuilder.cpp:115
HTTPRequestBuilder & contentType(const std::string &contentType)
Sets content-type.
Definition HTTPRequestBuilder.cpp:143
HTTPRequestBuilder & formParameter(const std::string &name, const std::string &value)
Adds form-parameter to the request.
Definition HTTPRequestBuilder.cpp:122
HTTPRequestBuilder & post()
Sets the method to POST.
Definition HTTPRequestBuilder.cpp:91
std::unique_ptr< HTTPRequest > build()
Builds the request.
Definition HTTPRequestBuilder.cpp:27
HTTPRequestBuilder & header(const std::string &name, const std::string &value, bool skipIfValueEmpty=true)
Adds header to the request.
Definition HTTPRequestBuilder.cpp:130
HTTPRequestBuilder & charset(const std::string &charset)
Sets character set.
Definition HTTPRequestBuilder.cpp:149
std::unique_ptr< HTTPCall > call()
Builds the request, and builds the call in one call.
Definition HTTPRequestBuilder.cpp:57
std::string buildMessageBodyFromFormParameters()
Builds the message body from form-parameters.
Definition HTTPRequestBuilder.cpp:66
HTTPRequestBuilder & authenticateWith(const std::shared_ptr< const tenduke::http::HTTPRequestAuthenticator > &requestAuthenticator)
Sets the request authenticator.
Definition HTTPRequestBuilder.cpp:109
HTTPRequestBuilder & utf8()
Sets the character set to UTF-8.
Definition HTTPRequestBuilder.cpp:155
tenduke::net::URLBuilder createURL() const
Starts URL-building.
Definition HTTPRequestBuilder.cpp:160
HTTPRequestBuilder(const ::tenduke::net::URLs &urls, tenduke::http::HTTPClient *client=nullptr, long connectionTimeoutMs=tenduke::http::DEFAULT_CONNECTION_TIMEOUT_MS, long timeoutMs=tenduke::http::DEFAULT_TIMEOUT_MS)
Constructs new instance.
Definition HTTPRequestBuilder.cpp:16
HTTPRequestBuilder & url(const std::string &url)
Sets the request URL.
Definition HTTPRequestBuilder.cpp:97
Very simple URL-builder.
Definition URLBuilder.h:24
Represents URL.
Definition URL.h:23
HTTP-related services.
Definition BadRequest.h:6
const long DEFAULT_CONNECTION_TIMEOUT_MS
Default connection time out in milliseconds.
Definition HTTPRequest.h:15
const long DEFAULT_TIMEOUT_MS
Default total time out in milliseconds.
Definition HTTPRequest.h:18
Root for classes, functions and globals of 10Duke C++ Client.
Definition APIRequest.h:4