smithy::AwsSignerBase< IDENTITY_T > Class Template Reference

#include <AwsSignerBase.h>

Inheritance diagram for smithy::AwsSignerBase< IDENTITY_T >:

Public Types

using IdentityT = IDENTITY_T

 

using SigningProperties = Aws::UnorderedMap< Aws::String, Aws::Crt::Variant< Aws::String, bool > >

 

using AdditionalParameters = Aws::UnorderedMap< Aws::String, Aws::Crt::Variant< Aws::String, bool > >

 

using HttpRequest = Aws::Http::HttpRequest

 

using SigningError = Aws::Client::AWSError< Aws::Client::CoreErrors >

 

using SigningFutureOutcome = Aws::Utils::FutureOutcome< std::shared_ptr< HttpRequest >, SigningError >

 

using SigningEventOutcome = Aws::Utils::Outcome< Aws::Utils::Event::Message, SigningError >

 

Public Member Functions

virtual SigningFutureOutcome sign (std::shared_ptr< HttpRequest > httpRequest, const IdentityT &identity, SigningProperties properties)=0

 

virtual SigningFutureOutcome presign (std::shared_ptr< HttpRequest > httpRequest, const IdentityT &identity, SigningProperties properties, const Aws::String &region, const Aws::String &serviceName, long long expirationTimeInSeconds)=0

 

virtual SigningEventOutcome signMessage (Aws::Utils::Event::Message &, Aws::String &, const IdentityT &, SigningProperties)

 

virtual ~AwsSignerBase ()

 

Public Member Functions inherited from smithy::AwsSignerCommon

virtual ~AwsSignerCommon ()=default

 

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

 

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

 

Additional Inherited Members

Protected Member Functions inherited from smithy::AwsSignerCommon

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

 

Protected Attributes inherited from smithy::AwsSignerCommon

std::atomic< std::chrono::milliseconds > m_clockSkew = {}

 

Detailed Description

template<typename IDENTITY_T>
class smithy::AwsSignerBase< IDENTITY_T >

Definition at line 38 of file AwsSignerBase.h.

Member Typedef Documentation

AdditionalParameters

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::AdditionalParameters = Aws::UnorderedMap<Aws::String, Aws::Crt::Variant<Aws::String, bool> >

Definition at line 43 of file AwsSignerBase.h.

HttpRequest

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::HttpRequest = Aws::Http::HttpRequest

Definition at line 44 of file AwsSignerBase.h.

IdentityT

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::IdentityT = IDENTITY_T

Definition at line 40 of file AwsSignerBase.h.

SigningError

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::SigningError = Aws::Client::AWSError<Aws::Client::CoreErrors>

Definition at line 45 of file AwsSignerBase.h.

SigningEventOutcome

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::SigningEventOutcome = Aws::Utils::Outcome<Aws::Utils::Event::Message, SigningError>

Definition at line 47 of file AwsSignerBase.h.

SigningFutureOutcome

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::SigningFutureOutcome = Aws::Utils::FutureOutcome<std::shared_ptr<HttpRequest>, SigningError>

Definition at line 46 of file AwsSignerBase.h.

SigningProperties

template<typename IDENTITY_T >

using smithy::AwsSignerBase< IDENTITY_T >::SigningProperties = Aws::UnorderedMap<Aws::String, Aws::Crt::Variant<Aws::String, bool> >

Definition at line 42 of file AwsSignerBase.h.

Constructor & Destructor Documentation

~AwsSignerBase()

template<typename IDENTITY_T >

virtual smithy::AwsSignerBase< IDENTITY_T >::~AwsSignerBase ( )

inlinevirtual

Definition at line 54 of file AwsSignerBase.h.

Member Function Documentation

presign()

template<typename IDENTITY_T >

virtual SigningFutureOutcome smithy::AwsSignerBase< IDENTITY_T >::presign ( std::shared_ptr< HttpRequest >  httpRequest,

const IdentityT &  identity,

SigningProperties  properties,

const Aws::String &  region,

const Aws::String &  serviceName,

long long  expirationTimeInSeconds 

)

pure virtual

Implemented in smithy::AwsNoAuthSigner, smithy::AwsSigV4aSigner, smithy::AwsSigV4Signer, and smithy::BearerTokenSigner.

sign()

template<typename IDENTITY_T >

virtual SigningFutureOutcome smithy::AwsSignerBase< IDENTITY_T >::sign ( std::shared_ptr< HttpRequest >  httpRequest,

const IdentityT &  identity,

SigningProperties  properties 

)

pure virtual

Implemented in smithy::AwsNoAuthSigner, smithy::AwsSigV4aSigner, smithy::AwsSigV4Signer, and smithy::BearerTokenSigner.

signMessage()

template<typename IDENTITY_T >

virtual SigningEventOutcome smithy::AwsSignerBase< IDENTITY_T >::signMessage ( Aws::Utils::Event::Message &  ,

Aws::String &  ,

const IdentityT &  ,

SigningProperties   

)

inlinevirtual

Reimplemented in smithy::AwsSigV4Signer.

Definition at line 52 of file AwsSignerBase.h.

---

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

• src/aws-cpp-sdk-core/include/smithy/identity/signer/AwsSignerBase.h