Apache Mesos
Public Member Functions | List of all members
mesos::http::authentication::Authenticatee Class Referenceabstract

An abstraction enabling any HTTP API consumer to authenticate. More...

#include <authenticatee.hpp>

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

Public Member Functions

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

Detailed Description

An abstraction enabling any HTTP API consumer to authenticate.

Constructor & Destructor Documentation

virtual mesos::http::authentication::Authenticatee::~Authenticatee ( )
virtualdefault

Member Function Documentation

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

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
requestThe HTTP payload intended to be sent to an authenticated endpoint.
credentialThe principal and secret optionally used to create the authentication request.
Returns
The mutated HTTP request object containing all information needed for authenticating.

Implemented in mesos::http::authentication::BasicAuthenticatee.

virtual void mesos::http::authentication::Authenticatee::reset ( )
inlinevirtual

Reset the authenticatee to its initial state.

Allows the implementation to invalidate possibly cached state. This is useful if for example token-based authentication is performed and the authenticator signaled an expired token.

virtual std::string mesos::http::authentication::Authenticatee::scheme ( ) const
pure virtual

Name of the authentication scheme implemented.

Returns
Authentication scheme.

Implemented in mesos::http::authentication::BasicAuthenticatee.


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