ANSLibs/chilkat/include/CkAuthAzureSAS.h

// CkAuthAzureSAS.h: interface for the CkAuthAzureSAS class.
//
//////////////////////////////////////////////////////////////////////

// This header is generated for Chilkat 11.3.0

#define _CkVersion 11.3.0

#ifndef _CkAuthAzureSAS_H
#define _CkAuthAzureSAS_H
	
#include "chilkatDefs.h"
#include "CkString.h"
#include "CkMultiByteBase.h"




#if !defined(__sun__) && !defined(__sun)
#pragma pack (push, 8)
#endif


#undef Copy

// CLASS: CkAuthAzureSAS
class CK_VISIBLE_PUBLIC CkAuthAzureSAS  : public CkMultiByteBase
{
    private:

	// Don't allow assignment or copying these objects.
	CkAuthAzureSAS(const CkAuthAzureSAS &);
	CkAuthAzureSAS &operator=(const CkAuthAzureSAS &);

    public:
	CkAuthAzureSAS(void);
	virtual ~CkAuthAzureSAS(void);

	static CkAuthAzureSAS *createNew(void);
	static CkAuthAzureSAS *createNew2(int progLang);
	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
	// ----------------------
	// This is the signing key (access key) that must be kept private. It is a base64
	// string such as
	// abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4
	// Y2eaw==
	void get_AccessKey(CkString &str);
	// This is the signing key (access key) that must be kept private. It is a base64
	// string such as
	// abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4
	// Y2eaw==
	const char *accessKey(void);
	// This is the signing key (access key) that must be kept private. It is a base64
	// string such as
	// abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4
	// Y2eaw==
	void put_AccessKey(const char *newVal);

	// Defines the format of the string to sign.
	// 
	// The format is specified as a comma-separated list of names. For example:
	// 
	// signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct
	// This will result in an actual string-to-sign that is composed of the values for
	// each name separated by newline (LF) chars. For example:signedpermissions + \n+  
	// signedstart + \n+  
	// signedexpiry + \n+  
	// canonicalizedresource + \n+  
	// signedidentifier + \n+  
	// signedIP + \n+  
	// signedProtocol + \n+  
	// signedversion + \n+  
	// rscc + \n+  
	// rscd + \n+  
	// rsce + \n+  
	// rscl + \n+  
	// rsct
	void get_StringToSign(CkString &str);
	// Defines the format of the string to sign.
	// 
	// The format is specified as a comma-separated list of names. For example:
	// 
	// signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct
	// This will result in an actual string-to-sign that is composed of the values for
	// each name separated by newline (LF) chars. For example:signedpermissions + \n+  
	// signedstart + \n+  
	// signedexpiry + \n+  
	// canonicalizedresource + \n+  
	// signedidentifier + \n+  
	// signedIP + \n+  
	// signedProtocol + \n+  
	// signedversion + \n+  
	// rscc + \n+  
	// rscd + \n+  
	// rsce + \n+  
	// rscl + \n+  
	// rsct
	const char *stringToSign(void);
	// Defines the format of the string to sign.
	// 
	// The format is specified as a comma-separated list of names. For example:
	// 
	// signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct
	// This will result in an actual string-to-sign that is composed of the values for
	// each name separated by newline (LF) chars. For example:signedpermissions + \n+  
	// signedstart + \n+  
	// signedexpiry + \n+  
	// canonicalizedresource + \n+  
	// signedidentifier + \n+  
	// signedIP + \n+  
	// signedProtocol + \n+  
	// signedversion + \n+  
	// rscc + \n+  
	// rscd + \n+  
	// rsce + \n+  
	// rscl + \n+  
	// rsct
	void put_StringToSign(const char *newVal);



	// ----------------------
	// Methods
	// ----------------------
	// Clears all params set by the methods SetNonTokenParam and SetTokenParam.
	void Clear(void);


	// Generates and returns the SAS token based on the defined StringToSign and
	// params.
	// 
	// References:
	// 1: #StringToSign
	bool GenerateToken(CkString &outStr);

	// Generates and returns the SAS token based on the defined StringToSign and
	// params.
	// 
	// References:
	// 1: #StringToSign
	const char *generateToken(void);

	// Adds a non-token parameter name/value. This is a value that is included in the
	// string to sign, but is NOT included in the token query params.
	bool SetNonTokenParam(const char *name, const char *value);


	// Adds a token parameter name/value. This is a value that is included in the
	// string to sign, and is also included in the token query params.
	bool SetTokenParam(const char *name, const char *authParamName, const char *value);






	// END PUBLIC INTERFACE


};
#if !defined(__sun__) && !defined(__sun)
#pragma pack (pop)
#endif
	
#endif