AuthAzureStorage Chilkat2 Java Reference Documentation
AuthAzureStorage
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.AuthAzureStorage
Hold the storage account name and Base64 account access key used to sign
Azure Storage REST requests.
Configure Azure Storage authentication using
Specify the Azure Storage service being accessed, such as
Set the
Use the configured object with
Pair this authentication object with manually constructed REST requests
when application code needs direct control over Azure Storage operations.
For an extended overview, see
AuthAzureStorage Class Overview.
Authenticate Azure Storage REST requests with account-key Shared Key signing.
Chilkat.AuthAzureStorage is a credential object for Azure
Storage Services authentication. It stores the storage account name, Base64
account access key, Azure Storage service type, authentication scheme, and
x-ms-version API version used when signing REST requests for
Blob, Queue, File, or Table storage.
Azure Storage credentials
Shared Key signing
SharedKey or
SharedKeyLite, depending on the service and request style.
Service targeting
Blob, Queue, File, or
Table.
API version header
x-ms-version value required by the Azure Storage
REST API version being used.
REST integration
Chilkat.Rest so requests are
signed automatically before being sent.
Low-level control
AuthAzureStorage object, set the storage
Account, Base64 AccessKey, Service,
Scheme, and XMsVersion, then attach it to a
Chilkat.Rest request workflow. Use
AuthAzureStorage for Shared Key authorization headers; use
Chilkat.AuthAzureSAS when the request should be authorized with
a SAS query token instead.
Object Creation
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.AuthAzureStorage;
try (AuthAzureStorage authAzureStorage = new AuthAzureStorage()) {
// ... use authAzureStorage ...
} catch (ChilkatException e) {
System.out.println(e.getMessage()); // "AuthAzureStorage.someMethod failed: <reason>"
System.out.println(e.getLastErrorText()); // the full log of the failed call
}Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).
Releases the native object (AuthAzureStorage is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.
Returns true once close() has been called.
Errors
A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.
A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.
Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.
Properties
AccessKey
String getAccessKey()
void setAccessKey(String value)
Account
String getAccount()
void setAccount(String value)
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. )
topDebugLogFilePath
String getDebugLogFilePath()
void setDebugLogFilePath(String value)
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.
LastErrorHtml
String getLastErrorHtml()
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.
topLastErrorText
String getLastErrorText()
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.
LastErrorXml
String getLastErrorXml()
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.
topLastMethodSuccess
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Scheme
String getScheme()
void setScheme(String value)
Can be SharedKey or SharedKeyLite. The default value is SharedKey.
Service
String getService()
void setService(String value)
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.
VerboseLogging
boolean getVerboseLogging()
void setVerboseLogging(boolean value)
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.
Version
String getVersion()
XMsVersion
String getXMsVersion()
void setXMsVersion(String value)
If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests. The default value is 2014-02-14.