libqtaws  0.1.0
UnofficialAWSlibraryforQt
Public Member Functions | List of all members
AwsAbstractSignature Class Referenceabstract

Interface class for providing AWS signatures. More...

Inheritance diagram for AwsAbstractSignature:
Inheritance graph
[legend]

Public Member Functions

virtual ~AwsAbstractSignature ()
 AwsAbstractSignature destructor.
 
virtual void sign (const AwsAbstractCredentials &credentials, const QNetworkAccessManager::Operation operation, QNetworkRequest &request, const QByteArray &data=QByteArray()) const =0
 Sign an AWS request. More...
 
virtual int version () const =0
 AWS Signature version implemented by this class. More...
 

Detailed Description

Interface class for providing AWS signatures.

Member Function Documentation

void AwsAbstractSignature::sign ( const AwsAbstractCredentials credentials,
const QNetworkAccessManager::Operation  operation,
QNetworkRequest &  request,
const QByteArray &  data = QByteArray() 
) const
pure virtual

Sign an AWS request.

Note, credentials must be valid before calling this function. So, for example, if credentials has expired, and is refreshable, it is the caller's responsibility to refresh the credentials before calling this function.

Parameters
operationThe network operation to sign request for.
requestThe network request to be signed.
credentialsThe credentials to use for signing.
dataOptional POST / PUT data to sign request for.

Implemented in AwsSignatureV2, AwsSignatureV3, AwsSignatureV4, and AwsSignatureV0.

int AwsAbstractSignature::version ( ) const
pure virtual

AWS Signature version implemented by this class.

Derived classes must implement this function to report the version of the AWS Signature implemented by the class.

Returns
The AWS Signature version implemented by this class.

Implemented in AwsSignatureV3, AwsSignatureV4, AwsSignatureV2, AwsSignatureV0, and AwsSignatureV1.


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