luciad::HttpClient::Builder Class Reference

Builder for the luciad::HttpClient class. More...

#include <luciad/net/http/HttpClient.h>

Public Member Functions
	Builder (Builder &&other) noexcept
	Builder (const Builder &other)
	~Builder ()
std::shared_ptr< HttpClient >	build () const
	Returns an luciad::HttpClient, based on the properties set on this builder. More...
Builder &	credentialProvider (std::shared_ptr< ICredentialsProvider > credentialsProvider)
	Sets the credentials provider used by the HttpClient. More...
Builder &	httpRequestOptions (HttpRequestOptions httpRequestOptions)
	Sets the HTTP request options to send with each HTTP request. More...
Builder &	operator= (Builder other) noexcept
Builder &	proxySelector (std::shared_ptr< IProxySelector > proxySelector)
	Sets the proxy selector used by the HttpClient. More...

Detailed Description

Builder for the luciad::HttpClient class.

Instances of HttpClient::Builder are created by calling luciad::HttpClient::newBuilder.

Since

2023.0

Constructor & Destructor Documentation

Builder() [1/2]

luciad::HttpClient::Builder::Builder

(

const Builder &

other

)

Builder() [2/2]

luciad::HttpClient::Builder::Builder ( Builder &&  other )

noexcept

~Builder()

luciad::HttpClient::Builder::~Builder

(

)

Member Function Documentation

build()

std::shared_ptr< HttpClient > luciad::HttpClient::Builder::build

(

)

const

Returns an luciad::HttpClient, based on the properties set on this builder.

Returns

an luciad::HttpClient, based on the properties set on this builder.

credentialProvider()

Builder & luciad::HttpClient::Builder::credentialProvider

(

std::shared_ptr< ICredentialsProvider >

credentialsProvider

)

Sets the credentials provider used by the HttpClient.

This parameter is optional. If not set, the credentials provider is taken from the environment.

Parameters

credentialsProvider

The credential provider to use.

Returns

this builder.

httpRequestOptions()

Builder & luciad::HttpClient::Builder::httpRequestOptions

(

HttpRequestOptions

httpRequestOptions

)

Sets the HTTP request options to send with each HTTP request.

This parameter is optional.

Parameters

httpRequestOptions

The http request options.

Returns

this builder.

operator=()

Builder & luciad::HttpClient::Builder::operator= ( Builder  other )

noexcept

proxySelector()

Builder & luciad::HttpClient::Builder::proxySelector

(

std::shared_ptr< IProxySelector >

proxySelector

)

Sets the proxy selector used by the HttpClient.

This parameter is optional. If not set, the proxy selector is taken from the environment.

Parameters

proxySelector

The proxy selector to use.

Returns

this builder.