StsRequest Class

(QtAws::STS::StsRequest)

The StsRequest class provides an interface for STS requests. More...

Header:	#include <StsRequest>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::STS::AssumeRoleRequest, QtAws::STS::AssumeRoleWithSAMLRequest, QtAws::STS::AssumeRoleWithWebIdentityRequest, QtAws::STS::DecodeAuthorizationMessageRequest, QtAws::STS::GetCallerIdentityRequest, QtAws::STS::GetFederationTokenRequest, and QtAws::STS::GetSessionTokenRequest

List of all members, including inherited members

Public Types

enum	Action { AssumeRoleAction, AssumeRoleWithSAMLAction, AssumeRoleWithWebIdentityAction, DecodeAuthorizationMessageAction, ..., GetSessionTokenAction }
flags	Actions

Public Functions

	StsRequest(const Action action)
	StsRequest(const StsRequest &other)
Action	action() const
QString	actionString() const
QString	apiVersion() const
void	setAction(const Action action)
void	setApiVersion(const QString &version)
StsRequest &	operator=(const StsRequest &other)
virtual bool	operator==(const StsRequest &other) const

7 public functions inherited from QtAws::Core::AwsAbstractRequest

Protected Functions

	StsRequest(StsRequestPrivate * const d)
int	clearParameter(const QString &name)
void	clearParameters()
QVariant	parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &	parameters() const
void	setParameter(const QString &name, const QVariant &value)
void	setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

4 protected functions inherited from QtAws::Core::AwsAbstractRequest

Detailed Description

The StsRequest class provides an interface for STS requests.

Member Type Documentation

enum StsRequest::Action
flags StsRequest::Actions

This enum describes the actions that can be performed as STS requests.

Constant	Value	Description
`QtAws::STS::StsRequest::AssumeRoleAction`	`0`	STS AssumeRole action.
`QtAws::STS::StsRequest::AssumeRoleWithSAMLAction`	`1`	STS AssumeRoleWithSAML action.
`QtAws::STS::StsRequest::AssumeRoleWithWebIdentityAction`	`2`	STS AssumeRoleWithWebIdentity action.
`QtAws::STS::StsRequest::DecodeAuthorizationMessageAction`	`3`	STS DecodeAuthorizationMessage action.
`QtAws::STS::StsRequest::GetCallerIdentityAction`	`4`	STS GetCallerIdentity action.
`QtAws::STS::StsRequest::GetFederationTokenAction`	`5`	STS GetFederationToken action.
`QtAws::STS::StsRequest::GetSessionTokenAction`	`6`	STS GetSessionToken action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

StsRequest::StsRequest(const Action action)

Constructs a StsRequest object for STS action.

StsRequest::StsRequest(const StsRequest &other)

Constructs a copy of other.

`[protected]` StsRequest::StsRequest(StsRequestPrivate * const d)

Constructs aa StsRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from StsRequestPrivate.

Action StsRequest::action() const

Returns the STS action to be performed by this request.

See also setAction().

QString StsRequest::actionString() const

Returns the name of the STS action to be performed by this request.

QString StsRequest::apiVersion() const

Returns the STS API version implemented by this request.

See also setApiVersion().

`[protected]` int StsRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

`[protected]` void StsRequest::clearParameters()

Removes all parameters from the request.

`[protected]` QVariant StsRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

`[protected]` const QVariantMap &StsRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void StsRequest::setAction(const Action action)

Sets the STS action to be performed by this request to action.

See also action().

void StsRequest::setApiVersion(const QString &version)

Sets the STS API version to include in this request to version.

See also apiVersion().

`[protected]` void StsRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

`[protected]` void StsRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

`[override virtual protected]` QNetworkRequest StsRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the STS request using the given endpoint.

This STS implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

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

Sets the StsRequest object to be equal to other.

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

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

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Contents