com.microsoft.azure.storage.blob

Class CloudBlobDirectory

java.lang.Object

com.microsoft.azure.storage.blob.CloudBlobDirectory

All Implemented Interfaces:

ListBlobItem

public final class CloudBlobDirectory
extends Object
implements ListBlobItem

Represents a virtual directory of blobs, designated by a delimiter character.

Containers, which are encapsulated as CloudBlobContainer objects, hold directories, and directories hold block blobs and page blobs. Directories can also contain sub-directories.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudBlobDirectory(StorageUri uri, String prefix, CloudBlobClient client, CloudBlobContainer container) Creates an instance of the CloudBlobDirectory class using the specified address, directory parent, and client.
protected	CloudBlobDirectory(StorageUri uri, String prefix, CloudBlobClient client, CloudBlobContainer container, CloudBlobDirectory parent) Creates an instance of the CloudBlobDirectory class using the specified address, directory parent, and client.

Method Summary

Modifier and Type	Method and Description
CloudAppendBlob	getAppendBlobReference(String blobName) Returns a reference to a CloudAppendBlob object that represents an append blob in the directory.
CloudAppendBlob	getAppendBlobReference(String blobName, String snapshotID) Returns a reference to a CloudAppendBlob object that represents an append blob in the directory, using the specified snapshot ID.
CloudBlockBlob	getBlockBlobReference(String blobName) Returns a reference to a CloudBlockBlob object that represents a block blob in this directory.
CloudBlockBlob	getBlockBlobReference(String blobName, String snapshotID) Returns a reference to a CloudBlockBlob object that represents a block blob in this directory, using the specified snapshot ID.
CloudBlobContainer	getContainer() Returns the container for this directory.
CloudBlobDirectory	getDirectoryReference(String directoryName) Returns a reference to a virtual blob directory beneath this directory.
CloudPageBlob	getPageBlobReference(String blobName) Returns a reference to a CloudPageBlob object that represents a page blob in the directory.
CloudPageBlob	getPageBlobReference(String blobName, String snapshotID) Returns a reference to a CloudPageBlob object that represents a page blob in the directory, using the specified snapshot ID.
CloudBlobDirectory	getParent() Returns the parent directory of this directory.
String	getPrefix() Returns the prefix for this directory.
CloudBlobClient	getServiceClient() Returns the Blob service client associated with this directory.
StorageUri	getStorageUri() Returns the list of URIs for all locations.
URI	getUri() Returns the URI for this directory.
Iterable<ListBlobItem>	listBlobs() Returns an enumerable collection of blob items for the directory.
Iterable<ListBlobItem>	listBlobs(String prefix) Returns an enumerable collection of blob items whose names begin with the specified prefix for the directory.
Iterable<ListBlobItem>	listBlobs(String prefix, boolean useFlatBlobListing, EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext) Returns an enumerable collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.
ResultSegment<ListBlobItem>	listBlobsSegmented() Returns a result segment of an enumerable collection of blob items in the directory.
ResultSegment<ListBlobItem>	listBlobsSegmented(String prefix) Returns a result segment containing a collection of blob items whose names begin with the specified prefix.
ResultSegment<ListBlobItem>	listBlobsSegmented(String prefix, boolean useFlatBlobListing, EnumSet<BlobListingDetails> listingDetails, Integer maxResults, ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext) Returns a result segment containing a collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudBlobDirectory

protected CloudBlobDirectory(StorageUri uri,
                             String prefix,
                             CloudBlobClient client,
                             CloudBlobContainer container)

Creates an instance of the CloudBlobDirectory class using the specified address, directory parent, and client.

Parameters:

uri - A StorageUri that represents the blob directory's address.

prefix - A String that represents the blob directory's prefix.

client - A CloudBlobClient object that represents the associated service client.

CloudBlobDirectory

protected CloudBlobDirectory(StorageUri uri,
                             String prefix,
                             CloudBlobClient client,
                             CloudBlobContainer container,
                             CloudBlobDirectory parent)

Creates an instance of the CloudBlobDirectory class using the specified address, directory parent, and client.

Parameters:

uri - A StorageUri that represents the blob directory's address.

prefix - A String that represents the blob directory's prefix.

parent - A CloudBlobDirectory object that represents the parent directory, if applicable.

client - A CloudBlobClient object that represents the associated service client.

Method Detail

getAppendBlobReference

public CloudAppendBlob getAppendBlobReference(String blobName)
                                       throws URISyntaxException,
                                              StorageException

Returns a reference to a CloudAppendBlob object that represents an append blob in the directory.

Parameters:

blobName - A String that represents the name of the blob.

Returns:

A CloudAppendBlob object that represents a reference to the specified append blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getAppendBlobReference

public CloudAppendBlob getAppendBlobReference(String blobName,
                                              String snapshotID)
                                       throws URISyntaxException,
                                              StorageException

Returns a reference to a CloudAppendBlob object that represents an append blob in the directory, using the specified snapshot ID.

Parameters:

blobName - A String that represents the name of the blob.

snapshotID - A String that represents the snapshot ID of the blob.

Returns:

A CloudAppendBlob object that represents a reference to the specified append blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getBlockBlobReference

public CloudBlockBlob getBlockBlobReference(String blobName)
                                     throws URISyntaxException,
                                            StorageException

Returns a reference to a CloudBlockBlob object that represents a block blob in this directory.

Parameters:

blobName - A String that represents the name of the blob.

Returns:

A CloudBlockBlob object that represents a reference to the specified block blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getBlockBlobReference

public CloudBlockBlob getBlockBlobReference(String blobName,
                                            String snapshotID)
                                     throws URISyntaxException,
                                            StorageException

Returns a reference to a CloudBlockBlob object that represents a block blob in this directory, using the specified snapshot ID.

Parameters:

blobName - A String that represents the name of the blob.

snapshotID - A String that represents the snapshot ID of the blob.

Returns:

A CloudBlockBlob object that represents a reference to the specified block blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getContainer

public CloudBlobContainer getContainer()
                                throws StorageException,
                                       URISyntaxException

Returns the container for this directory.

Specified by:

getContainer in interface ListBlobItem

Returns:

A CloudBlobContainer that represents the container for this directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getPageBlobReference

public CloudPageBlob getPageBlobReference(String blobName)
                                   throws URISyntaxException,
                                          StorageException

Returns a reference to a CloudPageBlob object that represents a page blob in the directory.

Parameters:

blobName - A String that represents the name of the blob.

Returns:

A CloudPageBlob object that represents a reference to the specified page blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getPageBlobReference

public CloudPageBlob getPageBlobReference(String blobName,
                                          String snapshotID)
                                   throws URISyntaxException,
                                          StorageException

Returns a reference to a CloudPageBlob object that represents a page blob in the directory, using the specified snapshot ID.

Parameters:

blobName - A String that represents the name of the blob.

snapshotID - A String that represents the snapshot ID of the blob.

Returns:

A CloudPageBlob object that represents a reference to the specified page blob.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getParent

public CloudBlobDirectory getParent()
                             throws URISyntaxException,
                                    StorageException

Returns the parent directory of this directory.

Specified by:

getParent in interface ListBlobItem

Returns:

A CloudBlobDirectory object that represents the parent of this directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

getPrefix

public String getPrefix()

Returns the prefix for this directory.

Returns:

A String that represents the prefix for this directory.

getServiceClient

public CloudBlobClient getServiceClient()

Returns the Blob service client associated with this directory.

Returns:

An CloudBlobClient object that represents the service client associated with the directory.

getDirectoryReference

public CloudBlobDirectory getDirectoryReference(String directoryName)
                                         throws URISyntaxException

Returns a reference to a virtual blob directory beneath this directory.

Parameters:

directoryName - A String that represents the name of the virtual subdirectory.

Returns:

A CloudBlobDirectory object that represents a virtual blob directory beneath this directory.

Throws:

URISyntaxException - If the resource URI is invalid.

getUri

public URI getUri()

Returns the URI for this directory.

Specified by:

getUri in interface ListBlobItem

Returns:

A java.net.URI object that represents the URI for this directory.

getStorageUri

public final StorageUri getStorageUri()

Returns the list of URIs for all locations.

Specified by:

getStorageUri in interface ListBlobItem

Returns:

A StorageUri that represents the list of URIs for all locations..

listBlobs

@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs()
                                                     throws StorageException,
                                                            URISyntaxException

Returns an enumerable collection of blob items for the directory.

Returns:

An enumerable collection of ListBlobItem objects that represent the block items in this container.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

listBlobs

@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs(String prefix)
                                                     throws URISyntaxException,
                                                            StorageException

Returns an enumerable collection of blob items whose names begin with the specified prefix for the directory.

Parameters:

prefix - A String that represents the blob name prefix.

Returns:

An enumerable collection of ListBlobItem objects that represent the block items whose names begin with the specified prefix in this directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

listBlobs

@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs(String prefix,
                                                            boolean useFlatBlobListing,
                                                            EnumSet<BlobListingDetails> listingDetails,
                                                            BlobRequestOptions options,
                                                            OperationContext opContext)
                                                     throws URISyntaxException,
                                                            StorageException

Returns an enumerable collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

Parameters:

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

useFlatBlobListing - true to indicate that the returned list will be flat; false to indicate that the returned list will be hierarchical.

listingDetails - A java.util.EnumSet object that contains BlobListingDetails values that indicate whether snapshots, metadata, and/or uncommitted blocks are returned. Committed blocks are always 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 ListBlobItem objects that represent the block items whose names begin with the specified prefix in this directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

listBlobsSegmented

@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented()
                                                                   throws StorageException,
                                                                          URISyntaxException

Returns a result segment of an enumerable collection of blob items in the directory.

Returns:

A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items in the directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

listBlobsSegmented

@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented(String prefix)
                                                                   throws StorageException,
                                                                          URISyntaxException

Returns a result segment containing a collection of blob items whose names begin with the specified prefix.

Parameters:

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

Returns:

A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items whose names begin with the specified prefix in the directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

listBlobsSegmented

@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented(String prefix,
                                                                          boolean useFlatBlobListing,
                                                                          EnumSet<BlobListingDetails> listingDetails,
                                                                          Integer maxResults,
                                                                          ResultContinuation continuationToken,
                                                                          BlobRequestOptions options,
                                                                          OperationContext opContext)
                                                                   throws StorageException,
                                                                          URISyntaxException

Returns a result segment containing a collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.

Parameters:

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

useFlatBlobListing - true to indicate that the returned list will be flat; false to indicate that the returned list will be hierarchical.

listingDetails - A java.util.EnumSet object that contains BlobListingDetails values that indicate whether snapshots, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned.

maxResults - The maximum number of results to retrieve.

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 ListBlobItem objects that represent the block items whose names begin with the specified prefix in the directory.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.