mesos::http::authentication::BasicAuthenticatee Class Reference

Authenticatee implementing the client side of basic HTTP authentication. More...

#include <basic_authenticatee.hpp>

Inheritance diagram for mesos::http::authentication::BasicAuthenticatee:

Public Member Functions
	BasicAuthenticatee ()
	~BasicAuthenticatee () override
	BasicAuthenticatee (const BasicAuthenticatee &)=delete
BasicAuthenticatee &	operator= (const BasicAuthenticatee &)=delete
std::string	scheme () const override
	Name of the authentication scheme implemented. More...
process::Future< process::http::Request >	authenticate (const process::http::Request &request, const Option< mesos::v1::Credential > &credential) override
	Create an HTTP request for authentication. More...
Public Member Functions inherited from mesos::http::authentication::Authenticatee
virtual	~Authenticatee ()=default
virtual void	reset ()
	Reset the authenticatee to its initial state. More...

Detailed Description

Authenticatee implementing the client side of basic HTTP authentication.

Constructor & Destructor Documentation

mesos::http::authentication::BasicAuthenticatee::BasicAuthenticatee

(

)

mesos::http::authentication::BasicAuthenticatee::~BasicAuthenticatee ( )

override

mesos::http::authentication::BasicAuthenticatee::BasicAuthenticatee ( const BasicAuthenticatee &  )

delete

Member Function Documentation

process::Future<process::http::Request> mesos::http::authentication::BasicAuthenticatee::authenticate ( const process::http::Request &  request, const Option< mesos::v1::Credential > &  credential  )

overridevirtual

Create an HTTP request for authentication.

Used for mutating a provided Request with any means of authentication-related headers or other additions and changes.

Parameters

request	The HTTP payload intended to be sent to an authenticated endpoint.
credential	The principal and secret optionally used to create the authentication request.

Returns

The mutated HTTP request object containing all information needed for authenticating.

Implements mesos::http::authentication::Authenticatee.

BasicAuthenticatee& mesos::http::authentication::BasicAuthenticatee::operator= ( const BasicAuthenticatee &  )

delete

std::string mesos::http::authentication::BasicAuthenticatee::scheme ( ) const

overridevirtual

Name of the authentication scheme implemented.

Returns

Authentication scheme.

Implements mesos::http::authentication::Authenticatee.

---

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

• src/authentication/http/basic_authenticatee.hpp