luciad::HttpResponse::Builder Class Reference

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

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

Public Member Functions
	Builder (Builder &&other) noexcept
	Move constructor.
	Builder (const Builder &other)
	Copy constructor.
	~Builder ()
Builder &	body (DataEntity body)
	Sets the HTTP response content.
HttpResponse	build () const
	Returns an luciad::HttpResponse based on the properties set on this builder.
Builder &	header (HttpHeader header)
	Sets the given http header to the set of headers for this response.
Builder &	header (std::string name, std::string value)
	Sets the given name value pair to the set of headers for this response.
Builder &	statusCode (int32_t statusCode)
	Sets the status code of the HTTP response.

Detailed Description

Builder for the luciad::HttpResponse class.

Instances of HttpRequest::Builder are created by calling luciad::HttpResponse::newBuilder.

Since

2023.0

Constructor & Destructor Documentation

~Builder()

luciad::HttpResponse::Builder::~Builder

(

)

Builder() [1/2]

luciad::HttpResponse::Builder::Builder

(

const Builder &

other

)

Copy constructor.

Parameters

other

the builder to copy.

Builder() [2/2]

luciad::HttpResponse::Builder::Builder ( Builder && other )

noexcept

Move constructor.

Parameters

other

the builder to move from.

Member Function Documentation

body()

Builder & luciad::HttpResponse::Builder::body

(

DataEntity

body

)

Sets the HTTP response content.

This parameter is optional.

Parameters

body	the response content.

Returns

this builder.

build()

HttpResponse luciad::HttpResponse::Builder::build

(

)

const

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

Returns

an luciad::HttpResponse.

Exceptions

luciad::LogicException

if the status code for this response has not been set.

header() [1/2]

Builder & luciad::HttpResponse::Builder::header

(

HttpHeader

header

)

Sets the given http header to the set of headers for this response.

Parameters

header

an luciad::HttpHeader.

Returns

this builder.

header() [2/2]

Builder & luciad::HttpResponse::Builder::header	(	std::string	name,
		std::string	value )

Sets the given name value pair to the set of headers for this response.

Parameters

name	header name
value	header value

Returns

this builder.

statusCode()

Builder & luciad::HttpResponse::Builder::statusCode

(

int32_t

statusCode

)

Sets the status code of the HTTP response.

This parameter is mandatory. If it is not set, HttpResponse::Builder::build will throw an exception.

Parameters

statusCode

the status code for this response.

Returns

this builder.