HTTPRequestBuilder Class Reference

#include <HTTPRequestBuilder.h>

Detailed Description

Builds HTTPRequest.

Public Member Functions
	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.
std::unique_ptr< HTTPRequest >	build ()
	Builds the request.
std::unique_ptr< HTTPCall >	call ()
	Builds the request, and builds the call in one call.
HTTPRequestBuilder &	get ()
	Sets the method to GET.
HTTPRequestBuilder &	post ()
	Sets the method to POST.
HTTPRequestBuilder &	url (const std::string &url)
	Sets the request URL.
HTTPRequestBuilder &	url (const ::tenduke::net::URL &url)
	Sets the request URL.
HTTPRequestBuilder &	authenticateWith (const std::shared_ptr< const tenduke::http::HTTPRequestAuthenticator > &requestAuthenticator)
	Sets the request authenticator.
HTTPRequestBuilder &	header (const std::string &name, const std::string &value, bool skipIfValueEmpty=true)
	Adds header to the request.
HTTPRequestBuilder &	formParameter (const std::string &name, const std::string &value)
	Adds form-parameter to the request.
HTTPRequestBuilder &	contentType (const std::string &contentType)
	Sets content-type.
HTTPRequestBuilder &	charset (const std::string &charset)
	Sets character set.
HTTPRequestBuilder &	utf8 ()
	Sets the character set to UTF-8.
HTTPRequestBuilder &	body (const std::string &requestEntity)
	Sets body as string.
tenduke::net::URLBuilder	createURL () const
	Starts URL-building.
::tenduke::net::URLBuilder	createURL (const ::tenduke::net::URL &url) const
	Starts URL-building, initialized from given URL.
::tenduke::net::URLBuilder	createURL (const std::string &url) const
	Starts URL-building, initialized from given URL.

Protected Member Functions
std::string	buildMessageBodyFromFormParameters ()
	Builds the message body from form-parameters.

Constructor & Destructor Documentation

HTTPRequestBuilder()

tenduke::http::HTTPRequestBuilder::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 )

explicit

Constructs new instance.

Parameters

urls	-
client	-
connectionTimeoutMs	-
timeoutMs	-

Member Function Documentation

authenticateWith()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::authenticateWith

(

const std::shared_ptr< const tenduke::http::HTTPRequestAuthenticator > &

requestAuthenticator

)

Sets the request authenticator.

Parameters

requestAuthenticator

-

Returns

instance for fluent method chaining.

body()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::body

(

const std::string &

requestEntity

)

Sets body as string.

Parameters

requestEntity

-

Returns

instance for fluent method chaining.

build()

std::unique_ptr< xdhttp::HTTPRequest > tenduke::http::HTTPRequestBuilder::build

(

)

Builds the request.

Returns

the request.

buildMessageBodyFromFormParameters()

std::string tenduke::http::HTTPRequestBuilder::buildMessageBodyFromFormParameters ( )

protected

Builds the message body from form-parameters.

Returns

-

call()

std::unique_ptr< xdhttp::HTTPCall > tenduke::http::HTTPRequestBuilder::call

(

)

Builds the request, and builds the call in one call.

NOTE: if HTTP-client not present, you will get an exception.

Remember to execute the call.

Returns

call for the request

Exceptions

tenduke::http::HTTPException

if the builder has not been configured with HTTP-client

charset()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::charset

(

const std::string &

charset

)

Sets character set.

Parameters

charset

-

Returns

instance for fluent method chaining.

contentType()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::contentType

(

const std::string &

contentType

)

Sets content-type.

Parameters

contentType

-

Returns

instance for fluent method chaining.

createURL() [1/3]

URLBuilder tenduke::http::HTTPRequestBuilder::createURL

(

)

const

Starts URL-building.

Returns

-

createURL() [2/3]

URLBuilder tenduke::http::HTTPRequestBuilder::createURL

(

const ::tenduke::net::URL &

url

)

const

Starts URL-building, initialized from given URL.

Parameters

url

-

Returns

-

createURL() [3/3]

URLBuilder tenduke::http::HTTPRequestBuilder::createURL

(

const std::string &

url

)

const

Starts URL-building, initialized from given URL.

Parameters

url

-

Returns

-

formParameter()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::formParameter	(	const std::string &	name,
		const std::string &	value )

Adds form-parameter to the request.

The method will PCT-encode the parameter (name and value).

Parameters

name	-
value	-

Returns

instance for fluent method chaining.

get()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::get

(

)

Sets the method to GET.

Returns

this instance for fluent method chaining.

header()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::header	(	const std::string &	name,
		const std::string &	value,
		bool	skipIfValueEmpty = true )

Adds header to the request.

Parameters

name	name of the header
value	value of the header
skipIfValueEmpty	if true and value is empty, the header will not be added.

Returns

instance for fluent method chaining.

post()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::post

(

)

Sets the method to POST.

Returns

instance for fluent method chaining.

url() [1/2]

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::url

(

const ::tenduke::net::URL &

url

)

Sets the request URL.

Parameters

url

-

Returns

instance for fluent method chaining.

url() [2/2]

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::url

(

const std::string &

url

)

Sets the request URL.

Parses the URL from the provided string.

Parameters

url

-

Returns

instance for fluent method chaining.

utf8()

xdhttp::HTTPRequestBuilder & tenduke::http::HTTPRequestBuilder::utf8

(

)

Sets the character set to UTF-8.

(Syntactic sugar).

Returns

instance for fluent method chaining.

---

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

• core/core/src/http/HTTPRequestBuilder.h
• core/core/src/http/HTTPRequestBuilder.cpp