AwsAbstractResponse Class

Member Function Documentation

AwsAbstractResponse::AwsAbstractResponse(QObject * const parent = 0)

Constructs an AwsAbstractResponse object with parent parent.

[virtual] AwsAbstractResponse::~AwsAbstractResponse()

Destroys the AWS response.

[virtual] QString AwsAbstractResponse::errorString() const

Returns the network reply error string, or a null string if none have occurred.

This base implementation returns either the internal network reply object's error string (if the reply object has an error), or the internal XML parse error (if one was set, eg via set setXmlError), otherwise a null QString.

Derived classes may override this function to support additional error types. Typically such derived implementations would check this base implementation's result first, or fallback to this base implementation. For example:

if (weHaveOurOwnCustomError()) {
    return customErrorString();
} else {
    return AwsAbstractResponse::errorString();
}

See also hasError(), networkError(), and xmlParseError().

[signal] void AwsAbstractResponse::finished()

Emitted when this object has finished parsing the response.

Upon receiving this signal, slots should check isValid or hasError to check if the response was successful or not.

[virtual] bool AwsAbstractResponse::hasError() const

Returns true if an error occurred processing this reponse; false otherwise.

Errors could be anything from network requests errors, to errors validating AWS response content.

This base implementation supports network, and XML parsing errors. Derived classes may override this function to support additional error types.

Note: This function may be equivalent to !isValid, however, it is not safe for this function's implementation to be just that, since derived classes may assume the inverse, resulting in an infinite cycle between the two functions.

See also errorString() and isValid().

[virtual protected] bool AwsAbstractResponse::isSuccess(QNetworkReply * const reply) const

Returns true if reply represents a successful reponse; false otherwise.

This base implementation simply checks that reply has no errors, and that it represents an HTTP response with a 2xx HTTP status code.

Derived classes may override this function to perform other checks, and/or to support non-HTTP responses.

This function is used by the base implementation of the parse function, to delegate responsibility to either the parseSuccess or parseFailure functions.

[virtual] bool AwsAbstractResponse::isValid() const

Returns true of this response is valid; false otherwise.

This base implementation simply checks for the absense of network and XML parsing errors. Derived classes may override this function to check other error types, and/or apply additional validation rules.

Note: This function may be equivalent to !hasError, however, it is not safe for this function's implementation to be just that, since derived classes may assume the inverse, resulting in an infinite cycle between the two functions.

See also hasError().

[virtual] QNetworkReply::NetworkError AwsAbstractResponse::networkError() const

Returns the network error, or QNetowkrReply::NoError is there is none.

See also hasError() and errorString().

[virtual protected] void AwsAbstractResponse::parse(QNetworkReply * const reply)

Parses an AWS response from a network reply.

This base implementation reports networks, if any occurred, otherwise uses the result of the virtual isSuccess function to delegate parsing to either the pure virtual parseSuccess or pure virtual parseFailure methods.

Typically derived classes will only implement parseSuccess and parseFailure, without needing to override this function.

[pure virtual protected] void AwsAbstractResponse::parseFailure(QIODevice &response)

Parses a failure response.

Derived classes must implement this function to process failure responses (as defined by the virtual isSuccess function).

[pure virtual protected] void AwsAbstractResponse::parseSuccess(QIODevice &response)

Parses a successful response.

Derived classes must implement this function to process successful responses (as defined by the virtual isSuccess function).

[virtual protected slot] void AwsAbstractResponse::replyFinished()

Executed when the internal network reply is finished.

This slot should only be connectedd to QNetworkReply signals (specifcally, this function asserts that the signal sender is an qobject-castable to QNetworkReply).

This is convenience slot, that really exists just to abstract the sender casting logic from the parse function (ie so derived classes can override parse without having to implement explicit casts).

[pure virtual] const AwsAbstractRequest *AwsAbstractResponse::request() const

Return the response's originating AWS request.

See also setRequest().

[protected] void AwsAbstractResponse::setReply(QNetworkReply * const reply)

Sets the network reply to listen for an AWS response.

[protected] void AwsAbstractResponse::setRequest(const AwsAbstractRequest * const request)

Sets the AWS request that originated this response.

Note: This object will take ownership of the request pointer, and will delete request on destruction.

Callers should normally create a new request instance (making use of the request classes' copy-constructors). For example:

setRequest(new SpecializedAwsRequest(specializedRequest));

See also request().

[protected] void AwsAbstractResponse::setXmlError(const QXmlStreamReader &xml)

Sets the XML error from xml.

If xml has no error, this effectively clears any existing XML parsing error.

See also xmlParseError and xmlParseErrorString.

[static] QVariantMap AwsAbstractResponse::toVariant(QXmlStreamReader &xml, const QString &prefix = QLatin1String( "." ), const int maxDepth = 1024)

Returns a QVariantMap representation of xml, stopping at maxDepth.

If supplied, prefix will be applied to special (non-element) child entry names.

This function is used internally to embed opaque XML structures, such as the SQS service's ErrorResponse::Error::Detail, which the SQS schema defines as an arbitrary complex type.

Note: This static function exists within the AwsAbstractResponse for historic reasons. It should probably be moved out of this class, and into a more generic utility space at some point.

@todo Move this toVariant function to somewhere more generic.

[virtual] QXmlStreamReader::Error AwsAbstractResponse::xmlParseError() const

Returns the XML parse error if there is one; QXmlStreamReader::NoError otherwise.

See also hasError and errorString.

[virtual] QString AwsAbstractResponse::xmlParseErrorString() const

Returns the XML parse error string, or a null string is there is none.

See also hasError and errorString.