AuthAzureStorage Java Reference Documentation

CkAuthAzureStorage

Current Version: 10.1.2
Requires Chilkat Bundle License

Provides functionality for authenticating calls to Azure Storage Services.

Object Creation

CkAuthAzureStorage obj = new CkAuthAzureStorage();

Properties

AccessKey
void get_AccessKey(CkString str);
String accessKey();
void put_AccessKey(String newVal);
Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

More Information and Examples
(Android™) Azure Storage Blob Simple Upload(Java) Azure Storage Blob Simple Upload
top
Account
void get_Account(CkString str);
String account();
void put_Account(String newVal);
Introduced in version 9.5.0.58

The Azure storage account name. (A storage account can contain zero or more containers. A container contains properties, metadata, and zero or more blobs. A blob is any single entity comprised of binary data, properties, and metadata. )

top
DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
(Android™) Example showing how to use DebugLogFilePath.(Java) Example showing how to use DebugLogFilePath.
top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
Scheme
void get_Scheme(CkString str);
String scheme();
void put_Scheme(String newVal);
Introduced in version 9.5.0.58

Can be "SharedKey" or "SharedKeyLite". The default value is "SharedKey".

top
Service
void get_Service(CkString str);
String service();
void put_Service(String newVal);
Introduced in version 9.5.0.58

Can be "Blob", "Queue", "File", or "Table". The default is "Blob".

Note: Authentication for the "Table" service did not work in versions prior to v9.5.0.83.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString str);
String version();

Version of the component/library, such as "10.1.0"

More Information and Examples
(Android™) How to get the Chilkat version at runtime.(Java) How to get the Chilkat version at runtime.
top
XMsVersion
void get_XMsVersion(CkString str);
String xMsVersion();
void put_XMsVersion(String newVal);
Introduced in version 9.5.0.58

If set, automatically adds the "x-ms-version" HTTP request header to Azure Storage requests. The default value is "2014-02-14".

top

Methods