AuthAzureSAS Chilkat2 Java Reference Documentation
AuthAzureSAS
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.AuthAzureSAS
Generate a signed query-string token that authorizes limited access to an
Azure Storage resource.
Provide the exact Azure SAS string-to-sign required for the storage
service and resource being accessed.
Use the Azure Storage account access key to compute the signature placed
in the generated SAS token.
Add signed SAS parameters such as permissions, expiry, resource type, API
version, protocol, or IP restrictions.
Add query parameters that should accompany the request but should not be
included as part of the SAS token itself.
Use the generated SAS query string with Azure Storage requests built
using
For an extended overview, see
AuthAzureSAS Class Overview.
Create Azure Shared Access Signature tokens for signed Azure Storage requests.
Chilkat.AuthAzureSAS creates Azure Shared Access Signature
authentication tokens. It defines the SAS string-to-sign, supplies the Azure
Storage account access key used to compute the signature, and controls which
parameters are included in the generated SAS token query string. The
resulting token can be used with Chilkat.Rest,
Chilkat.Http, or other request-building code that needs
time-limited, permission-scoped access to Azure Storage resources.
SAS token generation
String-to-sign control
Account key signing
Token parameters
Non-token parameters
REST integration
Chilkat.Rest or other Chilkat HTTP workflows.
AuthAzureSAS object, set the Azure Storage
AccessKey, provide the required StringToSign, add
SAS token parameters with SetTokenParam, add any extra query
parameters with SetNonTokenParam, then call
GenerateToken. Use AuthAzureSAS when you need a SAS
query token; use Chilkat.AuthAzureStorage when you need Shared
Key authorization headers instead.
Object Creation
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.AuthAzureSAS;
try (AuthAzureSAS authAzureSAS = new AuthAzureSAS()) {
// ... use authAzureSAS ...
} catch (ChilkatException e) {
System.out.println(e.getMessage()); // "AuthAzureSAS.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 (AuthAzureSAS 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)
This is the signing key (access key) that must be kept private. It is a base64 string such as abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw==
DebugLogFilePath
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.
StringToSign
String getStringToSign()
void setStringToSign(String value)
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,rsctThis 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
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()
Methods
Clear
Clears all params set by the methods SetNonTokenParam and SetTokenParam.
topGenerateToken
Generates and returns the SAS token based on the defined StringToSign and params.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
SetNonTokenParam
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.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
SetTokenParam
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.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.