StorageCredentials (Microsoft Azure Storage Android Client SDK 2.0.0 API)

java.lang.Object
- com.microsoft.azure.storage.StorageCredentials

Direct Known Subclasses:

StorageCredentialsAccountAndKey, StorageCredentialsAnonymous, StorageCredentialsSharedAccessSignature
```
public abstract class StorageCredentials
extends Object
```
Represents a set of credentials used to authenticate access to a Microsoft Azure storage account. This is the base class for the StorageCredentialsAccountAndKey and StorageCredentialsSharedAccessSignature classes.

Constructor Summary

Constructors
Constructor and Description

StorageCredentials()

Constructors
Constructor and Description
`StorageCredentials()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAccountName()` Returns the associated account name for the credentials.
`boolean`	`isHttpsOnly()` Gets whether this `StorageCredentials` object only allows access via HTTPS.
`abstract String`	`toString(boolean exportSecrets)` Returns a `String` that represents this instance.
`StorageUri`	`transformUri(StorageUri resourceUri)` Transforms a resource URI into a shared access signature URI, by appending a shared access token.
`abstract StorageUri`	`transformUri(StorageUri resourceUri, OperationContext opContext)` Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.
`URI`	`transformUri(URI resourceUri)` Transforms a resource URI into a shared access signature URI, by appending a shared access token.
`abstract URI`	`transformUri(URI resourceUri, OperationContext opContext)` Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.
`static StorageCredentials`	`tryParseCredentials(String connectionString)` Tries to determine the storage credentials from a connection string.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StorageCredentials
```
public StorageCredentials()
```
- Method Detail
  - tryParseCredentials
```
public static StorageCredentials tryParseCredentials(String connectionString)
                                              throws InvalidKeyException,
                                                     StorageException
```
    Tries to determine the storage credentials from a connection string.
    The format for the connection string is in the pattern "keyname=value". Multiple key/value pairs can be separated by a semi-colon, for example, "keyname1=value1;keyname2=value2". Either include an account name with an account key or a shared access signature. If you use an account name and account key, do not include a shared access signature, and vice versa.
    The same connection string can be used as for CloudStorageAccount.parse(String) but here only the account name, account key, and sas key/value pairs will be examined.
    
    Parameters:
    connectionString - A String that contains the key/value pairs that represent the storage credentials.
    
    Returns:
    A StorageCredentials object representing the storage credentials determined from the connection string.
    
    Throws:
    
    InvalidKeyException - If the account key specified in connectionString is not valid.
    
    StorageException
  - isHttpsOnly
```
public boolean isHttpsOnly()
```
    Gets whether this StorageCredentials object only allows access via HTTPS.
    
    Returns:
    A boolean representing whether this StorageCredentials object only allows access via HTTPS.
  - getAccountName
```
public String getAccountName()
```
    Returns the associated account name for the credentials. This is null for anonymous and shared access signature credentials.
    
    Returns:
    A String that represents the associated account name for the credentials
  - toString
```
public abstract String toString(boolean exportSecrets)
```
    Returns a String that represents this instance.
    
    Parameters:
    exportSecrets - true to include sensitive data in the return string; otherwise, false.
    
    Returns:
    A String that represents this object, optionally including sensitive data.
  - transformUri
```
public URI transformUri(URI resourceUri)
                 throws URISyntaxException,
                        StorageException
```
    Transforms a resource URI into a shared access signature URI, by appending a shared access token.
    
    Parameters:
    resourceUri - A java.net.URI object that represents the resource URI to be transformed.
    
    Returns:
    A java.net.URI object that represents the signature, including the resource URI and the shared access token.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is not properly formatted.
  - transformUri
```
public StorageUri transformUri(StorageUri resourceUri)
                        throws URISyntaxException,
                               StorageException
```
    Transforms a resource URI into a shared access signature URI, by appending a shared access token.
    
    Parameters:
    resourceUri - A StorageUri object that represents the resource URI to be transformed.
    
    Returns:
    A StorageUri object that represents the signature, including the resource URI and the shared access token.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is not properly formatted.
  - transformUri
```
public abstract URI transformUri(URI resourceUri,
               OperationContext opContext)
                          throws URISyntaxException,
                                 StorageException
```
    Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.
    
    Parameters:
    resourceUri - A java.net.URI object that represents the resource URI to be transformed.
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A java.net.URI object that represents the signature, including the resource URI and the shared access token.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is not properly formatted.
  - transformUri
```
public abstract StorageUri transformUri(StorageUri resourceUri,
                      OperationContext opContext)
                                 throws URISyntaxException,
                                        StorageException
```
    Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.
    
    Parameters:
    resourceUri - A StorageUri object that represents the resource URI to be transformed.
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A StorageUri object that represents the signature, including the resource URI and the shared access token.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is not properly formatted.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class StorageCredentials

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StorageCredentials

Method Detail

tryParseCredentials

isHttpsOnly

getAccountName

toString

transformUri

transformUri

transformUri

transformUri