com.microsoft.azure.storage.blob

Class CloudBlobClient

java.lang.Object

com.microsoft.azure.storage.ServiceClient

com.microsoft.azure.storage.blob.CloudBlobClient

public final class CloudBlobClient
extends ServiceClient

Provides a client for accessing the Microsoft Azure Blob service.

This class provides a point of access to the Blob service. The service client encapsulates the base URI for the Blob service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.

Constructor Summary

Constructors

Constructor and Description
CloudBlobClient(StorageUri baseUri) Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.
CloudBlobClient(StorageUri storageUri, StorageCredentials credentials) Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.
CloudBlobClient(URI baseUri) Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.
CloudBlobClient(URI baseUri, StorageCredentials credentials) Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

Method Summary

Methods

Modifier and Type	Method and Description
AccountInformation	downloadAccountInfo() Gets information related to the storage account.
AccountInformation	downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) Gets information related to the storage account.
ServiceProperties	downloadServiceProperties() Retrieves the current ServiceProperties for the given storage service.
ServiceProperties	downloadServiceProperties(BlobRequestOptions options, OperationContext opContext) Retrieves the current ServiceProperties for the given storage service.
<P,T> Map<P,T>	executeBatch(BlobBatchOperation<P,T> batch) Executes a pre-constructed batch operation on the blob service.
<P,T> Map<P,T>	executeBatch(BlobBatchOperation<P,T> batch, BlobRequestOptions requestOptions, OperationContext operationContext) Executes a pre-constructed batch operation on the blob service.
CloudBlobContainer	getContainerReference(String containerName) Gets a CloudBlobContainer object with the specified name.
BlobRequestOptions	getDefaultRequestOptions() Gets the BlobRequestOptions that is used for requests associated with this CloudBlobClient
String	getDirectoryDelimiter() Returns the value for the default delimiter used for cloud blob directories.
ServiceStats	getServiceStats() Queries the service for the ServiceStats.
ServiceStats	getServiceStats(BlobRequestOptions options, OperationContext opContext) Queries the given storage service for the ServiceStats.
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd) Requests a new user delegation key based on this client's oauth credentials.
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext) Requests a new user delegation key based on this client's oauth credentials.
Iterable<CloudBlobContainer>	listContainers() Returns an enumerable collection of blob containers for this Blob service client.
Iterable<CloudBlobContainer>	listContainers(String prefix) Returns an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client.
Iterable<CloudBlobContainer>	listContainers(String prefix, ContainerListingDetails detailsIncluded, BlobRequestOptions options, OperationContext opContext) Returns an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client, using the specified details setting, request options, and operation context.
ResultSegment<CloudBlobContainer>	listContainersSegmented() Returns a result segment of an enumerable collection of blob containers for this Blob service client.
ResultSegment<CloudBlobContainer>	listContainersSegmented(String prefix) Returns a result segment of an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client.
ResultSegment<CloudBlobContainer>	listContainersSegmented(String prefix, ContainerListingDetails detailsIncluded, Integer maxResults, ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext) Returns a result segment of an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client, using the specified listing details options, request options, and operation context.
void	setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions) Sets the BlobRequestOptions that is used for any requests associated with this CloudBlobClient object.
void	setDirectoryDelimiter(String directoryDelimiter) Sets the value for the default delimiter used for cloud blob directories.
void	uploadServiceProperties(ServiceProperties properties) Uploads a new ServiceProperties configuration to the given storage service.
void	uploadServiceProperties(ServiceProperties properties, BlobRequestOptions options, OperationContext opContext) Uploads a new ServiceProperties configuration to the given storage service.

Methods inherited from class com.microsoft.azure.storage.ServiceClient

getCredentials, getEndpoint, getStorageUri

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudBlobClient

public CloudBlobClient(URI baseUri)

Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.

Parameters:

baseUri - A java.net.URI object that represents the Blob service endpoint used to create the client.

CloudBlobClient

public CloudBlobClient(StorageUri baseUri)

Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.

Parameters:

baseUri - A StorageUri object that represents the Blob service endpoint used to create the client.

CloudBlobClient

public CloudBlobClient(URI baseUri,
               StorageCredentials credentials)

Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

Parameters:

baseUri - A java.net.URI object that represents the Blob service endpoint used to create the client.

credentials - A StorageCredentials object that represents the account credentials.

CloudBlobClient

public CloudBlobClient(StorageUri storageUri,
               StorageCredentials credentials)

Creates an instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

Parameters:

storageUri - A StorageUri object that represents the Blob service endpoint used to create the client.

credentials - A StorageCredentials object that represents the account credentials.

Method Detail

getContainerReference

public CloudBlobContainer getContainerReference(String containerName)
                                         throws URISyntaxException,
                                                StorageException

Gets a CloudBlobContainer object with the specified name.

Parameters:

containerName - The name of the container, which must adhere to container naming rules. The container name should not include any path separator characters (/). Container names must be lowercase, between 3-63 characters long and must start with a letter or number. Container names may contain only letters, numbers, and the dash (-) character.

Returns:

A reference to a CloudBlobContainer object.

Throws:

URISyntaxException - If the resource URI constructed based on the containerName is invalid.

StorageException - If a storage service error occurred.

See Also:

Naming and Referencing Containers, Blobs, and Metadata

getDirectoryDelimiter

public String getDirectoryDelimiter()

Returns the value for the default delimiter used for cloud blob directories. The default is '/'.

Returns:

A String which represents the value for the default delimiter.

listContainers

@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers()

Returns an enumerable collection of blob containers for this Blob service client.

Returns:

An enumerable collection of CloudBlobContainer objects retrieved lazily that represent the containers for this client.

listContainers

@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers(String prefix)

Returns an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client.

Parameters:

prefix - A String that represents the container name prefix.

Returns:

An enumerable collection of CloudBlobContainer objects retrieved lazily that represent the containers for this client whose names begin with the specified prefix.

listContainers

@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers(String prefix,
                                                             ContainerListingDetails detailsIncluded,
                                                             BlobRequestOptions options,
                                                             OperationContext opContext)

Returns an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client, using the specified details setting, request options, and operation context.

Parameters:

prefix - A String that represents the container name prefix.

detailsIncluded - A ContainerListingDetails value that indicates whether container metadata will be returned.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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:

An enumerable collection of CloudBlobContainer objects retrieved lazily that represents the containers for this client.

listContainersSegmented

@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented()
                                                          throws StorageException

Returns a result segment of an enumerable collection of blob containers for this Blob service client.

Returns:

A ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers for this client.

Throws:

StorageException - If a storage service error occurred.

listContainersSegmented

@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented(String prefix)
                                                          throws StorageException

Returns a result segment of an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client.

Parameters:

prefix - A String that represents the prefix of the container name.

Returns:

A ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers whose names begin with the specified prefix.

Throws:

StorageException - If a storage service error occurred.

listContainersSegmented

@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented(String prefix,
                                                                           ContainerListingDetails detailsIncluded,
                                                                           Integer maxResults,
                                                                           ResultContinuation continuationToken,
                                                                           BlobRequestOptions options,
                                                                           OperationContext opContext)
                                                          throws StorageException

Returns a result segment of an enumerable collection of blob containers whose names begin with the specified prefix for this Blob service client, using the specified listing details options, request options, and operation context.

Parameters:

prefix - A String that represents the prefix of the container name.

detailsIncluded - A ContainerListingDetails value that indicates whether container metadata will be returned.

maxResults - The maximum number of results to retrieve. If null or greater than 5000, the server will return up to 5,000 items. Must be at least 1.

continuationToken - A ResultContinuation object that represents a continuation token returned by a previous listing operation.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).

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 ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers for this Blob service client.

Throws:

StorageException - If a storage service error occurred.

getServiceStats

@DoesServiceRequest
public ServiceStats getServiceStats()
                             throws StorageException

Queries the service for the ServiceStats.

Returns:

A ServiceStats object for the given storage service.

Throws:

StorageException - If a storage service error occurred.

getServiceStats

@DoesServiceRequest
public ServiceStats getServiceStats(BlobRequestOptions options,
                                              OperationContext opContext)
                             throws StorageException

Queries the given storage service for the ServiceStats.

Parameters:

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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 ServiceStats object for the given storage service.

Throws:

StorageException - If a storage service error occurred.

downloadAccountInfo

@DoesServiceRequest
public AccountInformation downloadAccountInfo()
                                       throws StorageException

Gets information related to the storage account.

Returns:

A AccountInformation object for the given storage account.

Throws:

StorageException - If a storage service error occurred.

downloadAccountInfo

@DoesServiceRequest
public AccountInformation downloadAccountInfo(BlobRequestOptions options,
                                                        OperationContext opContext)
                                       throws StorageException

Gets information related to the storage account.

Parameters:

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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 AccountInformation object for the given storage account.

Throws:

StorageException - If a storage service error occurred.

downloadServiceProperties

@DoesServiceRequest
public final ServiceProperties downloadServiceProperties()
                                                  throws StorageException

Retrieves the current ServiceProperties for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Returns:

A ServiceProperties object representing the current configuration of the service.

Throws:

StorageException - If a storage service error occurred.

downloadServiceProperties

@DoesServiceRequest
public final ServiceProperties downloadServiceProperties(BlobRequestOptions options,
                                                             OperationContext opContext)
                                                  throws StorageException

Retrieves the current ServiceProperties for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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 ServiceProperties object representing the current configuration of the service.

Throws:

StorageException - If a storage service error occurred.

uploadServiceProperties

@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties)
                             throws StorageException

Uploads a new ServiceProperties configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

properties - A ServiceProperties object which specifies the service properties to upload.

Throws:

StorageException - If a storage service error occurred.

uploadServiceProperties

@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties,
                                              BlobRequestOptions options,
                                              OperationContext opContext)
                             throws StorageException

Uploads a new ServiceProperties configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

properties - A ServiceProperties object which specifies the service properties to upload.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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.

Throws:

StorageException - If a storage service error occurred.

getUserDelegationKey

@DoesServiceRequest
public UserDelegationKey getUserDelegationKey(Date keyStart,
                                                        Date keyEnd)
                                       throws StorageException

Requests a new user delegation key based on this client's oauth credentials.

Parameters:

keyStart - Start time of the requested key's validity.

keyEnd - End time of the requested key's validity.

Returns:

The requested key.

Throws:

StorageException

getUserDelegationKey

@DoesServiceRequest
public UserDelegationKey getUserDelegationKey(Date keyStart,
                                                        Date keyEnd,
                                                        BlobRequestOptions options,
                                                        OperationContext opContext)
                                       throws StorageException

Requests a new user delegation key based on this client's oauth credentials.

Parameters:

keyStart - Start time of the requested key's validity.

keyEnd - End time of the requested key's validity.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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:

The requested key.

Throws:

StorageException

executeBatch

public <P,T> Map<P,T> executeBatch(BlobBatchOperation<P,T> batch)
                      throws StorageException

Executes a pre-constructed batch operation on the blob service. For more information on constructing blob batch requests, see BlobBatchOperation.

Type Parameters:

P - The parent type of the individual operations.

T - The return type of the individual operations.

Parameters:

batch - The batch of operations to execute.

Returns:

A mapping from parent object in the batch to the response for that parent.

Throws:

BatchException - Throws this subset of storage exception if one or more individual requests on the batch fail.

StorageException - Throws if an error with the service occurs.

executeBatch

public <P,T> Map<P,T> executeBatch(BlobBatchOperation<P,T> batch,
                          BlobRequestOptions requestOptions,
                          OperationContext operationContext)
                      throws StorageException

Executes a pre-constructed batch operation on the blob service. For more information on constructing blob batch requests, see BlobBatchOperation.

Type Parameters:

P - The parent type of the individual operations.

T - The return type of the individual operations.

Parameters:

batch - The batch of operations to execute.

requestOptions - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

operationContext - 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 mapping from parent object in the batch to the response for that parent.

Throws:

BatchException - Throws this subset of storage exception if one or more individual requests on the batch fail.

StorageException - Throws if an error with the service occurs.

setDirectoryDelimiter

public void setDirectoryDelimiter(String directoryDelimiter)

Sets the value for the default delimiter used for cloud blob directories.

Parameters:

directoryDelimiter - A String that specifies the value for the default directory delimiter.

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

Gets the BlobRequestOptions that is used for requests associated with this CloudBlobClient

Specified by:

getDefaultRequestOptions in class ServiceClient

Returns:

The BlobRequestOptions object containing the values used by this CloudBlobClient

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

Sets the BlobRequestOptions that is used for any requests associated with this CloudBlobClient object.

Parameters:

defaultRequestOptions - A BlobRequestOptions object which specifies the options to use.