AwsAbstractSignature Class Reference

Interface class for providing AWS signatures. More...

Inheritance diagram for AwsAbstractSignature:

Collaboration diagram for AwsAbstractSignature:

Public Member Functions
	AwsAbstractSignature ()
	Initialises an AwsAbstractSignature object. More...
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...

Protected Member Functions
	AwsAbstractSignature (AwsAbstractSignaturePrivate *const d)
	Initialises an AwsAbstractSignature object. More...

Protected Attributes
AwsAbstractSignaturePrivate *const	d_ptr
	Internal d-pointer.

Friends
class	TestAwsAbstractSignature

Detailed Description

Interface class for providing AWS signatures.

Definition at line 33 of file awsabstractsignature.h.

Constructor & Destructor Documentation

AwsAbstractSignature::AwsAbstractSignature

(

)

Initialises an AwsAbstractSignature object.

This internal constrcutor is used by derived classes that do not wish to provider their own private implementations.

Definition at line 42 of file awsabstractsignature.cpp.

                                           : d_ptr(new AwsAbstractSignaturePrivate(this))
{

}

AwsAbstractSignature::AwsAbstractSignature ( AwsAbstractSignaturePrivate *const  d )

protected

Initialises an AwsAbstractSignature object.

This internal constrcutor is used by derived classes to provide their own private implementations if they wish to.

Parameters

d	Internal private implementation to use.

Definition at line 57 of file awsabstractsignature.cpp.

                                                                                : d_ptr(d)
{

}

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

operation	The network operation to sign request for.
request	The network request to be signed.
credentials	The credentials to use for signing.
data	Optional 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:

• core/awsabstractsignature.h
• core/awsabstractsignature.cpp