![]() |
Kea 2.7.3
|
Represents HTTP POST request. More...
#include <post_request.h>
Public Member Functions | |
PostHttpRequest () | |
Constructor for inbound HTTP request. | |
PostHttpRequest (const Method &method, const std::string &uri, const HttpVersion &version, const HostHttpHeader &host_header=HostHttpHeader(), const BasicHttpAuthPtr &basic_auth=BasicHttpAuthPtr()) | |
Constructor for outbound HTTP request. | |
![]() | |
HttpRequest () | |
Constructor for inbound HTTP request. | |
HttpRequest (const Method &method, const std::string &uri, const HttpVersion &version, const HostHttpHeader &host_header=HostHttpHeader(), const BasicHttpAuthPtr &basic_auth=BasicHttpAuthPtr()) | |
Constructor for outbound HTTP request. | |
const HttpRequestContextPtr & | context () const |
Returns pointer to the HttpRequestContext. | |
virtual void | create () |
Commits information held in the context into the request. | |
virtual void | finalize () |
Completes creation of the HTTP request. | |
std::string | getBasicAuth () const |
Returns recorded basic auth. | |
std::string | getBody () const |
Returns HTTP message body as string. | |
std::string | getCustom () const |
Returns recorded custom name. | |
std::string | getIssuer () const |
Returns recorded issuer name. | |
Method | getMethod () const |
Returns HTTP method of the request. | |
std::string | getRemote () const |
Returns remote address. | |
std::string | getSubject () const |
Returns recorded subject name. | |
bool | getTls () const |
Access control parameters: get/set methods. | |
std::string | getUri () const |
Returns HTTP request URI. | |
bool | isPersistent () const |
Checks if the client has requested persistent connection. | |
void | requireHttpMethod (const HttpRequest::Method &method) |
Specifies an HTTP method allowed for the request. | |
virtual void | reset () |
Reset the state of the object. | |
void | setBasicAuth (const std::string &basic_auth) |
Set (record) basic auth. | |
void | setCustom (const std::string &custom) |
Set (record) custom name. | |
void | setIssuer (const std::string &issuer) |
Set (record) issuer name. | |
void | setRemote (const std::string &remote) |
Set remote address. | |
void | setSubject (const std::string &subject) |
Set (record) subject name. | |
void | setTls (bool tls) |
Set (record) TLS usage. | |
std::string | toBriefString () const |
Returns HTTP method, URI and HTTP version as a string. | |
virtual std::string | toString () const |
Returns HTTP message as string. | |
![]() | |
HttpMessage (const Direction &direction) | |
Constructor. | |
virtual | ~HttpMessage () |
Destructor. | |
Direction | getDirection () const |
Returns HTTP message direction. | |
HttpHeaderPtr | getHeader (const std::string &header_name) const |
Returns object encapsulating HTTP header. | |
std::string | getHeaderValue (const std::string &header_name) const |
Returns a value of the specified HTTP header. | |
uint64_t | getHeaderValueAsUint64 (const std::string &header_name) const |
Returns a value of the specified HTTP header as number. | |
HttpVersion | getHttpVersion () const |
Returns HTTP version number (major and minor). | |
bool | isFinalized () const |
Checks if the message has been successfully finalized. | |
void | requireHeader (const std::string &header_name) |
Specifies a required HTTP header for the HTTP message. | |
void | requireHeaderValue (const std::string &header_name, const std::string &header_value) |
Specifies a required value of a header in the message. | |
void | requireHttpVersion (const HttpVersion &version) |
Specifies HTTP version allowed. | |
bool | requiresBody () const |
Checks if the body is required for the HTTP message. | |
void | setDirection (const Direction &direction) |
Sets direction for the HTTP message. | |
![]() | |
CalloutHandleAssociate () | |
Constructor. | |
CalloutHandlePtr | getCalloutHandle () |
Returns callout handle. | |
void | resetCalloutHandle () |
Reset callout handle. | |
Additional Inherited Members | |
![]() | |
enum class | Method { HTTP_GET , HTTP_POST , HTTP_HEAD , HTTP_PUT , HTTP_DELETE , HTTP_OPTIONS , HTTP_CONNECT , HTTP_METHOD_UNKNOWN } |
HTTP methods. More... | |
![]() | |
enum | Direction { INBOUND , OUTBOUND } |
Specifies the direction of the HTTP message. More... | |
![]() | |
static bool | recordBasicAuth_ = false |
Record basic auth. | |
static bool | recordIssuer_ = false |
Record issuer name. | |
static bool | recordSubject_ = false |
Access control parameters: Flags which indicate what information to record. | |
![]() | |
typedef std::map< std::string, HttpHeaderPtr > | HttpHeaderMap |
Map of HTTP headers indexed by lower case header names. | |
![]() | |
Method | methodFromString (std::string method) const |
Converts HTTP method specified in textual format to Method. | |
std::string | methodToString (const HttpRequest::Method &method) const |
Converts HTTP method to string. | |
![]() | |
void | checkCreated () const |
Checks if the create was called. | |
void | checkFinalized () const |
Checks if the finalize was called. | |
template<typename T > | |
bool | inRequiredSet (const T &element, const std::set< T > &element_set) const |
Checks if the set is empty or the specified element belongs to this set. | |
![]() | |
std::string | basic_auth_ |
Basic auth. | |
HttpRequestContextPtr | context_ |
Pointer to the HttpRequestContext holding parsed data. | |
std::string | custom_ |
Custom name. | |
std::string | issuer_ |
Issuer name. | |
Method | method_ |
HTTP method of the request. | |
std::string | remote_ |
Remote address. | |
std::set< Method > | required_methods_ |
Set of required HTTP methods. | |
std::string | subject_ |
Subject name. | |
bool | tls_ |
TLS usage. | |
![]() | |
bool | created_ |
Flag indicating whether create was called. | |
Direction | direction_ |
Message direction (inbound or outbound). | |
bool | finalized_ |
Flag indicating whether finalize was called. | |
HttpHeaderMap | headers_ |
Parsed HTTP headers. | |
HttpVersion | http_version_ |
HTTP version numbers. | |
HttpHeaderMap | required_headers_ |
Map holding required HTTP headers. | |
std::set< HttpVersion > | required_versions_ |
Set of required HTTP versions. | |
![]() | |
CalloutHandlePtr | callout_handle_ |
Callout handle stored. | |
Represents HTTP POST request.
Instructs the parent class to require:
Definition at line 29 of file post_request.h.
isc::http::PostHttpRequest::PostHttpRequest | ( | ) |
Constructor for inbound HTTP request.
Definition at line 14 of file post_request.cc.
References isc::http::HttpRequest::HTTP_POST, isc::http::HttpMessage::requireHeader(), and isc::http::HttpRequest::requireHttpMethod().
isc::http::PostHttpRequest::PostHttpRequest | ( | const Method & | method, |
const std::string & | uri, | ||
const HttpVersion & | version, | ||
const HostHttpHeader & | host_header = HostHttpHeader(), | ||
const BasicHttpAuthPtr & | basic_auth = BasicHttpAuthPtr() ) |
Constructor for outbound HTTP request.
method | HTTP method, e.g. POST. |
uri | URI. |
version | HTTP version. |
host_header | Host header to be included in the request. The default is the empty Host header. |
basic_auth | Basic HTTP authentication credential. The default is no authentication. |
Definition at line 21 of file post_request.cc.
References isc::http::HttpRequest::HTTP_POST, isc::http::HttpMessage::requireHeader(), and isc::http::HttpRequest::requireHttpMethod().