Data.Cloud.AmazonAPI.TAmazonAuthentication.BuildAuthorizationString

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function BuildAuthorizationString(const StringToSign: string): string; override;

C++

virtual System::UnicodeString __fastcall BuildAuthorizationString(const System::UnicodeString StringToSign);

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonAuthentication

Description

Builds the string to use as the value of the authorization header or Signature query parameter.

BuildAuthorizationString sets the authorization type (for the authorization header) to 'AWS'.

The StringToSign parameter represents the string to sign and use in authentication.

The StringToSign passed in is encoded using the ConnectionInfo of this class and the SignString function of the subclass. The result is then combined with the result returned by GetAuthorizationType to build the value string to use with the Authorization header, or the Signature query parameter of all requests to the cloud.

Note that the resulting format depends on the value of FAuthInHeader. The signed string will either be returned directly, or as part of an Authorization header formatted string.

See Also