org.jclouds.azureblob

Interface AzureBlobClient

All Superinterfaces:

AutoCloseable, Closeable

@Path(value="/")
public interface AzureBlobClient
extends Closeable

Provides access to Azure Blob via their REST API.

Method Summary

Modifier and Type	Method and Description
boolean	blobExists(String container, String name)
boolean	containerExists(String container) Issues a HEAD command to determine if the container exists or not.
String	copyBlob(URI copySource, String toContainer, String toName, CopyBlobOptions options)
boolean	createContainer(String container, CreateContainerOptions... options) The Create Container operation creates a new container under the specified identity.
boolean	createRootContainer(CreateContainerOptions... options) The root container is a default container that may be inferred from a URL requesting a blob resource.
void	deleteBlob(String container, String name) The Delete Blob operation marks the specified blob for deletion.
void	deleteContainer(String container) The Delete Container operation marks the specified container for deletion.
void	deleteRootContainer() The Delete Container operation marks the specified container for deletion.
AzureBlob	getBlob(String container, String name, GetOptions... options) The Get Blob operation reads or downloads a blob from the system, including its metadata and properties.
BlobProperties	getBlobProperties(String container, String name) The Get Blob Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob.
ListBlobBlocksResponse	getBlockList(String container, String name)
ContainerProperties	getContainerProperties(String container) The Get Container Properties operation returns all user-defined metadata and system properties for the specified container.
PublicAccess	getPublicAccessForContainer(String container) Returns whether data in the container may be accessed publicly and the level of access
ListBlobsResponse	listBlobs(ListBlobsOptions... options)
ListBlobsResponse	listBlobs(String container, ListBlobsOptions... options) The List Blobs operation enumerates the list of blobs under the specified container.
BoundedSet<ContainerProperties>	listContainers(ListOptions... listOptions) The List Containers operation returns a list of the containers under the specified identity.
AzureBlob	newBlob()
String	putBlob(String container, AzureBlob object) The Put Blob operation creates a new blob or updates the content of an existing blob.
void	putBlock(String container, String name, String blockId, Payload part) The Put Block operation creates a block blob on Azure which can be later assembled into a single, large blob object with the Put Block List operation.
String	putBlockList(String container, AzureBlob object, List<String> blockIdList) The Put Block List assembles a list of blocks previously uploaded with Put Block into a single blob.
String	putBlockList(String container, String name, List<String> blockIdList) Deprecated. call putBlockList(String, AzureBlob, List<String>) instead
String	setBlobMetadata(String container, String name, Map<String,String> metadata)
String	setBlobProperties(String container, String name, ContentMetadata contentMetadata)
void	setBlobTier(String container, String name, AccessTier tier)
String	setPublicAccessForContainer(String container, PublicAccess access) Returns whether data in the container may be accessed publicly and the level of access
void	setResourceMetadata(String container, Map<String,String> metadata) The Set Container Metadata operation sets one or more user-defined name/value pairs for the specified container.

Methods inherited from interface java.io.Closeable

close

Method Detail

newBlob

@Provides
AzureBlob newBlob()

listContainers

@Named(value="ListContainers")
 @GET
BoundedSet<ContainerProperties> listContainers(ListOptions... listOptions)

The List Containers operation returns a list of the containers under the specified identity.

The 2009-07-17 version of the List Containers operation times out after 30 seconds.

Parameters:

listOptions - controls the number or type of results requested

See Also:

ListOptions

createContainer

@Named(value="CreateContainer")
 @PUT
 @Path(value="{container}")
boolean createContainer(@PathParam(value="container")
                                                                                          String container,
                                                                                          CreateContainerOptions... options)

The Create Container operation creates a new container under the specified identity. If the container with the same name already exists, the operation fails.

The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

Returns:

true, if the bucket was created or false, if the container was already present

See Also:

CreateContainerOptions

getContainerProperties

@Named(value="GetContainerProperties")
 @HEAD
 @Path(value="{container}")
ContainerProperties getContainerProperties(@PathParam(value="container")
                                                                                                                     String container)

The Get Container Properties operation returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.

containerExists

@Named(value="GetContainerProperties")
 @HEAD
 @Path(value="{container}")
boolean containerExists(@PathParam(value="container")
                                                                                                  String container)

Issues a HEAD command to determine if the container exists or not.

setResourceMetadata

@Named(value="SetContainerMetadata")
 @PUT
 @Path(value="{container}")
void setResourceMetadata(@PathParam(value="container")
                                                                                                String container,
                                                                                                Map<String,String> metadata)

The Set Container Metadata operation sets one or more user-defined name/value pairs for the specified container.

Remarks

Calling the Set Container Metadata operation overwrites all existing metadata that is associated with the container. It's not possible to modify an individual name/value pair.

You may also set metadata for a container at the time it is created.

Calling Set Container Metadata updates the ETag for the container.

deleteContainer

@Named(value="DeleteContainer")
 @DELETE
 @Path(value="{container}")
void deleteContainer(@PathParam(value="container")
                                                                                          String container)

The Delete Container operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.

When a container is deleted, a container with the same name cannot be created for at least 30 seconds; the container may not be available for more than 30 seconds if the service is still processing the request. While the container is being deleted, attempts to create a container of the same name will fail with status code 409 (Conflict), with the service returning additional error information indicating that the container is being deleted. All other operations, including operations on any blobs under the container, will fail with status code 404 (Not Found) while the container is being deleted.

createRootContainer

@Named(value="CreateContainer")
 @PUT
 @Path(value="$root")
boolean createRootContainer(CreateContainerOptions... options)

The root container is a default container that may be inferred from a URL requesting a blob resource. The root container makes it possible to reference a blob from the top level of the storage identity hierarchy, without referencing the container name.

The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

See Also:

CreateContainerOptions

getPublicAccessForContainer

@Named(value="GetContainerACL")
 @HEAD
 @Path(value="{container}")
PublicAccess getPublicAccessForContainer(@PathParam(value="container")
                                                                                                            String container)

Returns whether data in the container may be accessed publicly and the level of access

setPublicAccessForContainer

@Named(value="SetContainerACL")
 @PUT
 @Path(value="{container}")
String setPublicAccessForContainer(@PathParam(value="container")
                                                                                                     String container,
                                                                                                     PublicAccess access)

Returns whether data in the container may be accessed publicly and the level of access

deleteRootContainer

@Named(value="DeleteContainer")
 @DELETE
 @Path(value="$root")
void deleteRootContainer()

The Delete Container operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.

Remarks

When a container is deleted, a container with the same name cannot be created for at least 30 seconds; the container may not be available for more than 30 seconds if the service is still processing the request. While the container is being deleted, attempts to create a container of the same name will fail with status code 409 (Conflict), with the service returning additional error information indicating that the container is being deleted. All other operations, including operations on any blobs under the container, will fail with status code 404 (Not Found) while the container is being deleted.

See Also:

deleteContainer(String), createRootContainer(CreateContainerOptions...)

listBlobs

@Named(value="ListBlobs")
 @GET
 @Path(value="{container}")
ListBlobsResponse listBlobs(@PathParam(value="container")
                                                                                        String container,
                                                                                        ListBlobsOptions... options)

The List Blobs operation enumerates the list of blobs under the specified container.

Authorization

If the container's access control list (ACL) is set to allow anonymous access, any client may call this operation.

Remarks

If you specify a value for the maxresults parameter and the number of blobs to return exceeds this value, or exceeds the default value for maxresults, the response body will contain a NextMarker element that indicates the next blob to return on a subsequent request. To return the next set of items, specify the value of NextMarker as the marker parameter on the URI for the subsequent request.

Note that the value of NextMarker should be treated as opaque.

The delimiter parameter enables the caller to traverse the blob keyspace by using a user-configured delimiter. The delimiter may be a single character or a string. When the request includes this parameter, the operation returns a BlobPrefix element. The BlobPrefix element is returned in place of all blobs whose keys begin with the same substring up to the appearance of the delimiter character. The value of the BlobPrefix element is substring+delimiter, where substring is the common substring that begins one or more blob keys, and delimiter is the value of the delimiter parameter.

You can use the value of BlobPrefix to make a subsequent call to list the blobs that begin with this prefix, by specifying the value of BlobPrefix for the prefix parameter on the request URI. In this way, you can traverse a virtual hierarchy of blobs as though it were a file system.

Note that each BlobPrefix element returned counts toward the maximum result, just as each Blob element does.

Blobs are listed in alphabetical order in the response body.

listBlobs

@Named(value="ListBlobs")
 @GET
 @Path(value="$root")
ListBlobsResponse listBlobs(ListBlobsOptions... options)

putBlob

@Named(value="PutBlob")
 @PUT
 @Path(value="{container}/{name}")
String putBlob(@PathParam(value="container")
                                                                                String container,
                                                                                @PathParam(value="name")
                                                                                AzureBlob object)

The Put Blob operation creates a new blob or updates the content of an existing blob.

Updating an existing blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the content of the new blob.

Remarks

The maximum upload size for a blob is 256 MB. If your blob is larger than 256 MB, you may upload it as a set of blocks. For more information, see the Put Block and Put Block List operations.

If you attempt to upload a blob that is larger than 256 MB, the service returns status code 413 (Request Payload Too Large). The Blob service also returns additional information about the error in the response, including the maximum blob size permitted in bytes.

getBlob

@Named(value="GetBlob")
 @GET
 @Path(value="{container}/{name}")
AzureBlob getBlob(@PathParam(value="container")
                                                                                   String container,
                                                                                   @PathParam(value="name")
                                                                                   String name,
                                                                                   GetOptions... options)

The Get Blob operation reads or downloads a blob from the system, including its metadata and properties.

putBlock

@Named(value="PutBlock")
 @PUT
 @Path(value="{container}/{name}")
void putBlock(@PathParam(value="container")
                                                                                String container,
                                                                                @PathParam(value="name")
                                                                                String name,
                                                                                @QueryParam(value="blockid")
                                                                                String blockId,
                                                                                Payload part)

The Put Block operation creates a block blob on Azure which can be later assembled into a single, large blob object with the Put Block List operation.

putBlockList

@Deprecated
 @Named(value="PutBlockList")
 @PUT
 @Path(value="{container}/{name}")
String putBlockList(@PathParam(value="container")
                                                                                                       String container,
                                                                                                       @PathParam(value="name")
                                                                                                       String name,
                                                                                                       List<String> blockIdList)

Deprecated. call putBlockList(String, AzureBlob, List<String>) instead

The Put Block List assembles a list of blocks previously uploaded with Put Block into a single blob. Blocks are either already committed to a blob or uncommitted. The blocks ids passed here are searched for first in the uncommitted block list; then committed using the "latest" strategy.

putBlockList

@Named(value="PutBlockList")
 @PUT
 @Path(value="{container}/{name}")
String putBlockList(@PathParam(value="container")
                                                                                          String container,
                                                                                          @PathParam(value="name")
                                                                                          AzureBlob object,
                                                                                          List<String> blockIdList)

The Put Block List assembles a list of blocks previously uploaded with Put Block into a single blob. Blocks are either already committed to a blob or uncommitted. The blocks ids passed here are searched for first in the uncommitted block list; then committed using the "latest" strategy.

getBlockList

@Named(value="GetBlockList")
 @GET
 @Path(value="{container}/{name}")
ListBlobBlocksResponse getBlockList(@PathParam(value="container")
                                                                                                          String container,
                                                                                                          @PathParam(value="name")
                                                                                                          String name)

getBlobProperties

@Named(value="GetBlobProperties")
 @HEAD
 @Path(value="{container}/{name}")
BlobProperties getBlobProperties(@PathParam(value="container")
                                                                                                             String container,
                                                                                                             @PathParam(value="name")
                                                                                                             String name)

The Get Blob Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

setBlobProperties

@Named(value="SetBlobProperties")
 @PUT
 @Path(value="{container}/{name}")
String setBlobProperties(@PathParam(value="container")
                                                                                                    String container,
                                                                                                    @PathParam(value="name")
                                                                                                    String name,
                                                                                                    ContentMetadata contentMetadata)

setBlobMetadata

@Named(value="SetBlobMetadata")
 @PUT
 @Path(value="{container}/{name}")
String setBlobMetadata(@PathParam(value="container")
                                                                                                String container,
                                                                                                @PathParam(value="name")
                                                                                                String name,
                                                                                                Map<String,String> metadata)

setBlobTier

@Named(value="SetAccessTier")
 @PUT
 @Path(value="{container}/{name}")
void setBlobTier(@PathParam(value="container")
                                                                                        String container,
                                                                                        @PathParam(value="name")
                                                                                        String name,
                                                                                        @HeaderParam(value="x-ms-access-tier")
                                                                                        AccessTier tier)

deleteBlob

@Named(value="DeleteBlob")
 @DELETE
 @Path(value="{container}/{name}")
void deleteBlob(@PathParam(value="container")
                                                                                       String container,
                                                                                       @PathParam(value="name")
                                                                                       String name)

The Delete Blob operation marks the specified blob for deletion. The blob is later deleted during garbage collection.

blobExists

@Named(value="GetBlobProperties")
 @HEAD
 @Path(value="{container}/{name}")
boolean blobExists(@PathParam(value="container")
                                                                                               String container,
                                                                                               @PathParam(value="name")
                                                                                               String name)

Throws:

ContainerNotFoundException - if the container is not present.

copyBlob

@Named(value="CopyBlob")
 @PUT
 @Path(value="{toContainer}/{toName}")
String copyBlob(@PathParam(value="copySource")
                                                                                      URI copySource,
                                                                                      @PathParam(value="toContainer")
                                                                                      String toContainer,
                                                                                      @PathParam(value="toName")
                                                                                      String toName,
                                                                                      CopyBlobOptions options)

Throws:

ContainerNotFoundException - if the container is not present.