// CkAuthAwsW.h: interface for the CkAuthAwsW class. // ////////////////////////////////////////////////////////////////////// // This header is generated for Chilkat 9.5.0.75 #ifndef _CkAuthAwsW_H #define _CkAuthAwsW_H #include "chilkatDefs.h" #include "CkString.h" #include "CkWideCharBase.h" #if !defined(__sun__) && !defined(__sun) #pragma pack (push, 8) #endif // CLASS: CkAuthAwsW class CK_VISIBLE_PUBLIC CkAuthAwsW : public CkWideCharBase { private: // Don't allow assignment or copying these objects. CkAuthAwsW(const CkAuthAwsW &); CkAuthAwsW &operator=(const CkAuthAwsW &); public: CkAuthAwsW(void); virtual ~CkAuthAwsW(void); static CkAuthAwsW *createNew(void); void CK_VISIBLE_PRIVATE inject(void *impl); // May be called when finished with the object to free/dispose of any // internal resources held by the object. void dispose(void); // BEGIN PUBLIC INTERFACE // ---------------------- // Properties // ---------------------- // The AWS access key. void get_AccessKey(CkString &str); // The AWS access key. const wchar_t *accessKey(void); // The AWS access key. void put_AccessKey(const wchar_t *newVal); // If AWS Signature Version V2 is used, then this property must be set. The rules // for setting the canonicalized resource for the V2 signature method is described // here: Constructing the CanonicalizedResource Element // . void get_CanonicalizedResourceV2(CkString &str); // If AWS Signature Version V2 is used, then this property must be set. The rules // for setting the canonicalized resource for the V2 signature method is described // here: Constructing the CanonicalizedResource Element // . const wchar_t *canonicalizedResourceV2(void); // If AWS Signature Version V2 is used, then this property must be set. The rules // for setting the canonicalized resource for the V2 signature method is described // here: Constructing the CanonicalizedResource Element // . void put_CanonicalizedResourceV2(const wchar_t *newVal); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the base64 encoding of the 16 bytes of the MD5 // hash. The most common need for this is if doing an S3 upload from a stream. (If // the pre-computed MD5 is not provided, then Chilkat is forced to stream the // entire file into memory so that it can calculate the MD5 for authentication.) // // Note: AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses // SHA256. // void get_PrecomputedMd5(CkString &str); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the base64 encoding of the 16 bytes of the MD5 // hash. The most common need for this is if doing an S3 upload from a stream. (If // the pre-computed MD5 is not provided, then Chilkat is forced to stream the // entire file into memory so that it can calculate the MD5 for authentication.) // // Note: AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses // SHA256. // const wchar_t *precomputedMd5(void); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the base64 encoding of the 16 bytes of the MD5 // hash. The most common need for this is if doing an S3 upload from a stream. (If // the pre-computed MD5 is not provided, then Chilkat is forced to stream the // entire file into memory so that it can calculate the MD5 for authentication.) // // Note: AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses // SHA256. // void put_PrecomputedMd5(const wchar_t *newVal); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the lowercase hex encoding of the 32-bytes of the // SHA256 hash. The most common need for this is if doing an S3 upload from a // stream. (If the pre-computed SHA-256 is not provided, then Chilkat is forced to // stream the entire file into memory so that it can calculate the SHA-256 for // authentication.) // // Note: AWS Signature Version 4 uses the SHA256 hash. (AWS Signature Version 2 // uses MD5) // void get_PrecomputedSha256(CkString &str); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the lowercase hex encoding of the 32-bytes of the // SHA256 hash. The most common need for this is if doing an S3 upload from a // stream. (If the pre-computed SHA-256 is not provided, then Chilkat is forced to // stream the entire file into memory so that it can calculate the SHA-256 for // authentication.) // // Note: AWS Signature Version 4 uses the SHA256 hash. (AWS Signature Version 2 // uses MD5) // const wchar_t *precomputedSha256(void); // This property can optionally be set for AWS requests that have a non-empty // request body. This should be the lowercase hex encoding of the 32-bytes of the // SHA256 hash. The most common need for this is if doing an S3 upload from a // stream. (If the pre-computed SHA-256 is not provided, then Chilkat is forced to // stream the entire file into memory so that it can calculate the SHA-256 for // authentication.) // // Note: AWS Signature Version 4 uses the SHA256 hash. (AWS Signature Version 2 // uses MD5) // void put_PrecomputedSha256(const wchar_t *newVal); // The AWS region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", // etc. The default is "us-east-1". It is only used when the SignatureVersion // property is set to 4. This property is unused when the SignatureVersion property // is set to 2. void get_Region(CkString &str); // The AWS region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", // etc. The default is "us-east-1". It is only used when the SignatureVersion // property is set to 4. This property is unused when the SignatureVersion property // is set to 2. const wchar_t *region(void); // The AWS region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", // etc. The default is "us-east-1". It is only used when the SignatureVersion // property is set to 4. This property is unused when the SignatureVersion property // is set to 2. void put_Region(const wchar_t *newVal); // The AWS secret key. void get_SecretKey(CkString &str); // The AWS secret key. const wchar_t *secretKey(void); // The AWS secret key. void put_SecretKey(const wchar_t *newVal); // The AWS service namespace, such as "s3", "ses", etc. See // http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref- // aws-service-namespaces // // This property is unused when the SignatureVersion property is set to 2. // void get_ServiceName(CkString &str); // The AWS service namespace, such as "s3", "ses", etc. See // http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref- // aws-service-namespaces // // This property is unused when the SignatureVersion property is set to 2. // const wchar_t *serviceName(void); // The AWS service namespace, such as "s3", "ses", etc. See // http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref- // aws-service-namespaces // // This property is unused when the SignatureVersion property is set to 2. // void put_ServiceName(const wchar_t *newVal); // The AWS Signature Version to be used in authentication. The default value is 4. // This can optionally be set to the value 2 to use the older V2 signature version. int get_SignatureVersion(void); // The AWS Signature Version to be used in authentication. The default value is 4. // This can optionally be set to the value 2 to use the older V2 signature version. void put_SignatureVersion(int newVal); // ---------------------- // Methods // ---------------------- // END PUBLIC INTERFACE }; #if !defined(__sun__) && !defined(__sun) #pragma pack (pop) #endif #endif