AwsAbstractRequest Class

Member Function Documentation

AwsAbstractRequest::AwsAbstractRequest()

Constructs an AwsAbstractRequest object.

AwsAbstractRequest::AwsAbstractRequest(const AwsAbstractRequest &other)

Constructs a copy of other.

[virtual] AwsAbstractRequest::~AwsAbstractRequest()

Destroys the AWS request.

[virtual] QByteArray AwsAbstractRequest::data() const

Returns data to be included with PUT and/or POST operations.

See also setData().

[pure virtual] bool AwsAbstractRequest::isValid() const

Returns true if this request is valid; false otherwise.

Derived classes must implement this function to provide a level of request validation relevant to the type of request being implemented.

In this context, "valid" means that with valid credentials, the request's networkRequest method should return a request that the caller can reasonably expect AWS to accept (ignoring server side access restrictions and the like).

[virtual] QNetworkRequest AwsAbstractRequest::networkRequest(const QUrl &endpoint, const AwsAbstractSignature &signature, const AwsAbstractCredentials &credentials) const

Returns a QNetwokrRequest object that can be used to send this AWS request to Amazon.

This base implementation fetches the basic request for endpoint via unsignedRequest, then uses signature and credentials to sign the request before returning to the caller.

Derived classes may override this if their specific AWS service required more advanced logic (or disallow signing, for example).

[virtual] QNetworkAccessManager::Operation AwsAbstractRequest::operation() const

Returns the network operation to use when sending this request.

This defaults to QNetworkAccessManager::GetOperation unless overridden or changed via setOperation.

See also setOperation().

[pure virtual protected] AwsAbstractResponse *AwsAbstractRequest::response(QNetworkReply * const reply) const

Return an AWS response object for reply.

Derived classes must implement this pure virtual function to return the relevant AwsAbstractResponse-derived object for their request type.

For example, the SqsCreateQueueRequest::response implementation returns an instance of the related SqsCreateQueueResponse class. Typically an AwsAbstractClient-derived class will cast this the returned pointer to the relevant known type in its send method.

[virtual] AwsAbstractResponse *AwsAbstractRequest::send(QNetworkAccessManager &manager, const QUrl &endpoint, const AwsAbstractSignature &signature, const AwsAbstractCredentials &credentials) const

Sends this request to the Amazon endpoint via network access manager.

If appropriate, signature and credentials will be used to sign the request.

Returns an AwsAbstractResponse-derived object representing the AWS service's response.

[protected] void AwsAbstractRequest::setData(const QByteArray &data)

Sets the data to be used with POST and/or PUT operations.

See also data().

[protected] void AwsAbstractRequest::setOperation(const QNetworkAccessManager::Operation operation)

Sets the network operation to use when submitting this request.

See also operation().

[pure virtual protected] QNetworkRequest AwsAbstractRequest::unsignedRequest(const QUrl &endpoint) const

Returns a network request for this AWS request for the given AWS endpoint.

Derived classes must implement this pure virtual function to build network requests that the networkRequest function can sign, before being subitted to Amazon.

AwsAbstractRequest &AwsAbstractRequest::operator=(const AwsAbstractRequest &other)

Sets the AwsAbstractRequest object to be equal to other.

[virtual] bool AwsAbstractRequest::operator==(const AwsAbstractRequest &other) const

Returns true if this request is equal to other; false otherwise.