Aws::Client::AWSAuthBearerSigner Class Reference

#include <AWSAuthBearerSigner.h>

Inheritance diagram for Aws::Client::AWSAuthBearerSigner:

Public Member Functions

 AWSAuthBearerSigner (const std::shared_ptr< Aws::Auth::AWSBearerTokenProviderBase > bearerTokenProvider)

 

virtual ~AWSAuthBearerSigner ()

 

const char * GetName () const override

 

bool SignRequest (Aws::Http::HttpRequest &) const override

 

bool SignRequest (Aws::Http::HttpRequest &ioRequest, const char *, const char *, bool) const override

 

bool PresignRequest (Aws::Http::HttpRequest &ioRequest, long long) const override

 

bool PresignRequest (Aws::Http::HttpRequest &ioRequest, const char *, long long expirationInSeconds=0) const override

 

bool PresignRequest (Aws::Http::HttpRequest &ioRequest, const char *, const char *, long long expirationInSeconds=0) const override

 

std::shared_ptr< Aws::Auth::AWSBearerTokenProviderBase > BearerTokenProvider () const

 

Public Member Functions inherited from Aws::Client::AWSAuthSigner

 AWSAuthSigner ()

 

virtual ~AWSAuthSigner ()=default

 

virtual bool SignRequest (Aws::Http::HttpRequest &request, bool signBody) const

 

virtual bool SignRequest (Aws::Http::HttpRequest &request, const char *region, bool signBody) const

 

virtual bool SignEventMessage (Aws::Utils::Event::Message &, Aws::String &) const

 

virtual void SetClockSkew (const std::chrono::milliseconds &clockSkew)

 

virtual Aws::Utils::DateTime GetSigningTimestamp () const

 

Protected Attributes

std::shared_ptr< Aws::Auth::AWSBearerTokenProviderBase > m_bearerTokenProvider

 

Protected Attributes inherited from Aws::Client::AWSAuthSigner

std::atomic< std::chrono::milliseconds > m_clockSkew

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSAuthSigner

virtual std::chrono::milliseconds GetClockSkewOffset () const

 

Detailed Description

Definition at line 34 of file AWSAuthBearerSigner.h.

Constructor & Destructor Documentation

AWSAuthBearerSigner()

Aws::Client::AWSAuthBearerSigner::AWSAuthBearerSigner ( const std::shared_ptr< Aws::Auth::AWSBearerTokenProviderBase >  bearerTokenProvider)

inline

An implementation of a signer interface that uses bearer token auth signature.

Definition at line 41 of file AWSAuthBearerSigner.h.

~AWSAuthBearerSigner()

virtual Aws::Client::AWSAuthBearerSigner::~AWSAuthBearerSigner ( )

inlinevirtual

Definition at line 45 of file AWSAuthBearerSigner.h.

Member Function Documentation

BearerTokenProvider()

std::shared_ptr< Aws::Auth::AWSBearerTokenProviderBase > Aws::Client::AWSAuthBearerSigner::BearerTokenProvider ( ) const

inline

Definition at line 100 of file AWSAuthBearerSigner.h.

GetName()

const char * Aws::Client::AWSAuthBearerSigner::GetName ( ) const

inlineoverridevirtual

Return the signer's name

Implements Aws::Client::AWSAuthSigner.

Definition at line 50 of file AWSAuthBearerSigner.h.

PresignRequest() [1/3]

bool Aws::Client::AWSAuthBearerSigner::PresignRequest ( Aws::Http::HttpRequest &  ioRequest,

const char *  ,

const char *  ,

long long  expirationInSeconds = 0 

) const

inlineoverridevirtual

Dummy function to satisfy the interface requirements of a base Signer interface additional arguments are not used.

Returns

true if success, false if fail to sign

Implements Aws::Client::AWSAuthSigner.

Definition at line 95 of file AWSAuthBearerSigner.h.

PresignRequest() [2/3]

bool Aws::Client::AWSAuthBearerSigner::PresignRequest ( Aws::Http::HttpRequest &  ioRequest,

const char *  ,

long long  expirationInSeconds = 0 

) const

inlineoverridevirtual

Dummy function to satisfy the interface requirements of a base Signer interface additional arguments are not used.

Returns

true if success, false if fail to sign

Implements Aws::Client::AWSAuthSigner.

Definition at line 85 of file AWSAuthBearerSigner.h.

PresignRequest() [3/3]

bool Aws::Client::AWSAuthBearerSigner::PresignRequest ( Aws::Http::HttpRequest &  ioRequest,

long long   

) const

inlineoverridevirtual

Dummy function to satisfy the interface requirements of a base Signer interface

Returns

true if success, false if fail to sign

Implements Aws::Client::AWSAuthSigner.

Definition at line 75 of file AWSAuthBearerSigner.h.

SignRequest() [1/2]

bool Aws::Client::AWSAuthBearerSigner::SignRequest ( Aws::Http::HttpRequest &  ) const

overridevirtual

Sign request with a bearer auth token

Returns

true if success, false if fail to sign

Implements Aws::Client::AWSAuthSigner.

SignRequest() [2/2]

bool Aws::Client::AWSAuthBearerSigner::SignRequest ( Aws::Http::HttpRequest &  ioRequest,

const char *  ,

const char *  ,

bool   

) const

inlineoverridevirtual

Dummy function to satisfy the interface requirements of a base Signer interface additional arguments are not used.

Returns

true if success, false if fail to sign

Reimplemented from Aws::Client::AWSAuthSigner.

Definition at line 66 of file AWSAuthBearerSigner.h.

Member Data Documentation

m_bearerTokenProvider

std::shared_ptr<Aws::Auth::AWSBearerTokenProviderBase> Aws::Client::AWSAuthBearerSigner::m_bearerTokenProvider

protected

Definition at line 103 of file AWSAuthBearerSigner.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/auth/signer/AWSAuthBearerSigner.h