10Duke Enterprise C++ SDK
Loading...
Searching...
No Matches
URLBuilder.h
1#ifndef TENDUKE_NET_URLBUILDER_H
2#define TENDUKE_NET_URLBUILDER_H
3
4#include "./URL.h"
5
6#include <map>
7#include <memory>
8#include <string>
9#include <vector>
10
11namespace tenduke { namespace net {
12
13class URLCodec;
14
24{
25public:
29 explicit URLBuilder(const ::tenduke::net::URLCodec &urls);
30
37 const ::tenduke::net::URLCodec &urls,
38 const ::tenduke::net::URL *url
39 );
40
46
51 std::unique_ptr<::tenduke::net::URL> buildPtr();
52
57 std::string buildString();
58
59 URLBuilder &scheme(const char *scheme, std::size_t length);
60 URLBuilder &scheme(const std::string &scheme);
61 URLBuilder &username(const char *username, std::size_t length);
62 URLBuilder &username(const std::string &scheme);
63 URLBuilder &password(const char *password, std::size_t length);
64 URLBuilder &password(const std::string &password);
71 URLBuilder &hostname(const char *hostname, std::size_t length);
72
78 URLBuilder &hostname(const std::string &hostname);
79 URLBuilder &port(std::uint16_t port);
80
89 URLBuilder &path(const std::string &path);
90
99 URLBuilder &path(const char *path, std::size_t length);
100
109 URLBuilder &encodedPath(const std::string &encodedPath);
110
119 URLBuilder &encodedPath(const char *encodedPath, std::size_t length);
120 URLBuilder &fragment(const char *fragment, std::size_t length);
121 URLBuilder &fragment(const std::string &fragment);
122
131 URLBuilder & appendPath(const std::string & pathComponent);
132
139 URLBuilder & baseURL(const ::tenduke::net::URL &url);
140
146 URLBuilder &queryParameter(const char * name);
147
153 URLBuilder &queryParameter(const std::string & name);
154
161 URLBuilder &queryParameter(const char * name, const char * value);
162
169 URLBuilder &queryParameter(const std::string &name, const std::string &value);
170
177 URLBuilder &queryParameter(const char *name, std::size_t length);
178
187 URLBuilder &queryParameter(const char *name, std::size_t nameLength, const char * value, std::size_t valueLength);
188
189
195 URLBuilder & queryParameters(const std::map<std::string, std::string> &pParameters);
196
206 URLBuilder & encodedQueryParameter(const char *name, const char * value);
207
216 URLBuilder & encodedQueryParameter(const std::string &name, const std::string &value ="");
217
227 const char *name,
228 std::size_t nameLength
229 );
230
242 const char *name,
243 std::size_t nameLength,
244 const char *value,
245 std::size_t valueLength
246 );
247
253 std::string pctEncode(const std::string &value) const;
254
255private:
256 void putParameter (const std::string &name, const std::string &value);
257
258private:
259 std::string schemeValue;
260 std::string usernameValue;
261 std::string passwordValue;
262 std::string hostnameValue;
263 std::uint16_t portValue;
264 std::string pathValue;
265 std::string fragmentValue;
266 std::vector<std::pair<std::string, std::string>> parameters;
267
268 const ::tenduke::net::URLCodec &urls;
269};
270
271}}
272
273#endif // TENDUKE_NET_URLBUILDER_H
std::string buildString()
Builds the URL directly into a string.
Definition URLBuilder.cpp:12
URLBuilder & queryParameters(const std::map< std::string, std::string > &pParameters)
Sets multiple query parameters.
Definition URLBuilder.cpp:309
URLBuilder & hostname(const char *hostname, std::size_t length)
Sets the hostname.
Definition URLBuilder.cpp:118
URLBuilder & path(const std::string &path)
Sets the entire path: Overwrites any existing path.
Definition URLBuilder.cpp:149
std::string pctEncode(const std::string &value) const
Utility to PCT-encode a string.
Definition URLBuilder.cpp:398
URLBuilder & baseURL(const ::tenduke::net::URL &url)
Sets the base URL.
Definition URLBuilder.cpp:56
::tenduke::net::URL build()
Builds the URL.
Definition URLBuilder.cpp:27
URLBuilder(const ::tenduke::net::URLCodec &urls)
Constructs a new instance.
Definition URLBuilder.cpp:404
URLBuilder & encodedQueryParameter(const char *name, const char *value)
Adds an encoded query parameter.
Definition URLBuilder.cpp:337
URLBuilder & queryParameter(const char *name)
Adds query parameter without a value.
Definition URLBuilder.cpp:232
URLBuilder & appendPath(const std::string &pathComponent)
Appends a path component.
Definition URLBuilder.cpp:187
URLBuilder & encodedPath(const std::string &encodedPath)
Sets the entire path from an already encoded path: Overwrites any existing path.
Definition URLBuilder.cpp:164
std::unique_ptr<::tenduke::net::URL > buildPtr()
Builds the URL into a pointer.
Definition URLBuilder.cpp:41
URL-related coding / encoding functionality.
Definition URLCodec.h:13
Represents URL.
Definition URL.h:23
Generic networking support.
Definition AbstractURLCodec.h:6
Root for classes, functions and globals of 10Duke C++ Client.
Definition APIRequest.h:4