org.jclouds.blobstore.config

Class LocalBlobStore

java.lang.Object

org.jclouds.blobstore.config.LocalBlobStore

All Implemented Interfaces:

BlobStore

@Singleton
public final class LocalBlobStore
extends Object
implements BlobStore

Method Summary

Methods

Modifier and Type	Method and Description
void	abortMultipartUpload(MultipartUpload mpu)
BlobBuilder	blobBuilder(String name)
boolean	blobExists(String containerName, String key) Determines if a blob exists
BlobMetadata	blobMetadata(String containerName, String key) Retrieves the metadata of a Blob at location container/name
void	clearContainer(String containerName) This implementation invokes clearContainer(java.lang.String) with the ListContainerOptions.recursive option.
void	clearContainer(String containerName, ListContainerOptions options) Like BlobStore.clearContainer(String) except you can use options to do things like recursive deletes, or clear at a different path than root.
String	completeMultipartUpload(MultipartUpload mpu, List<MultipartPart> parts)
boolean	containerExists(String containerName) determines if a service-level container exists
String	copyBlob(String fromContainer, String fromName, String toContainer, String toName, CopyOptions options) Copy blob from one container to another.
long	countBlobs(String containerName) This implementation invokes countBlobs(java.lang.String) with the ListContainerOptions.recursive option.
long	countBlobs(String containerName, ListContainerOptions options) This implementation invokes BlobUtils.countBlobs(java.lang.String, org.jclouds.blobstore.options.ListContainerOptions)
boolean	createContainerInLocation(org.jclouds.domain.Location location, String name) Creates a namespace for your blobs A container is a namespace for your objects.
boolean	createContainerInLocation(org.jclouds.domain.Location location, String container, CreateContainerOptions options)
void	createDirectory(String containerName, String directory) Creates a folder or a directory marker depending on the service
void	deleteContainer(String containerName) This implementation invokes deleteAndVerifyContainerGone(java.lang.String)
boolean	deleteContainerIfEmpty(String containerName) Deletes a container if it is empty.
void	deleteDirectory(String containerName, String directory) Deletes a folder or a directory marker depending on the service
boolean	directoryExists(String containerName, String directory) Determines if a directory exists
void	downloadBlob(String container, String name, File destination)
void	downloadBlob(String container, String name, File destination, ExecutorService executor)
Blob	getBlob(String containerName, String key) This implementation invokes getBlob(String,String, GetOptions)
Blob	getBlob(String containerName, String key, GetOptions options) Retrieves a Blob representing the data at location container/name
BlobAccess	getBlobAccess(String container, String name)
ContainerAccess	getContainerAccess(String container)
BlobStoreContext	getContext()
long	getMaximumMultipartPartSize()
int	getMaximumNumberOfParts()
long	getMinimumMultipartPartSize()
MultipartUpload	initiateMultipartUpload(String container, BlobMetadata blobMetadata, PutOptions options)
PageSet<? extends StorageMetadata>	list() Lists all root-level resources available to the identity.
PageSet<? extends StorageMetadata>	list(String containerName) This implementation invokes list(String, ListContainerOptions)
PageSet<? extends StorageMetadata>	list(String containerName, ListContainerOptions options) default maxResults is 1000
Set<? extends org.jclouds.domain.Location>	listAssignableLocations() The get locations command returns all the valid locations for containers.
List<MultipartPart>	listMultipartUpload(MultipartUpload mpu)
List<MultipartUpload>	listMultipartUploads(String container)
String	putBlob(String containerName, Blob blob) Adds a Blob representing the data at location container/blob.metadata.name
String	putBlob(String containerName, Blob blob, PutOptions options) Adds a Blob representing the data at location container/blob.metadata.name options using multipart strategies.
void	removeBlob(String containerName, String key) Deletes a Blob representing the data at location container/name
void	removeBlobs(String container, Iterable<String> names) Deletes multiple Blobs representing the data at location container/name
void	setBlobAccess(String container, String name, BlobAccess access)
void	setContainerAccess(String container, ContainerAccess access)
InputStream	streamBlob(String container, String name)
InputStream	streamBlob(String container, String name, ExecutorService executor)
MultipartPart	uploadMultipartPart(MultipartUpload mpu, int partNumber, org.jclouds.io.Payload payload)

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public BlobStoreContext getContext()

Specified by:

getContext in interface BlobStore

Returns:

a reference to the context that created this BlobStore.

blobBuilder

public BlobBuilder blobBuilder(String name)

Specified by:

blobBuilder in interface BlobStore

Returns:

builder for creating new Blobs

list

public PageSet<? extends StorageMetadata> list(String containerName)

This implementation invokes list(String, ListContainerOptions)

Specified by:

list in interface BlobStore

Parameters:

containerName - what to list

Returns:

a list that may be incomplete, depending on whether PageSet#getNextMarker is set

countBlobs

public long countBlobs(String containerName)

This implementation invokes countBlobs(java.lang.String) with the ListContainerOptions.recursive option.

Specified by:

countBlobs in interface BlobStore

Returns:

a count of all blobs in the container, excluding directory markers

countBlobs

public long countBlobs(String containerName,
              ListContainerOptions options)

This implementation invokes BlobUtils.countBlobs(java.lang.String, org.jclouds.blobstore.options.ListContainerOptions)

Specified by:

countBlobs in interface BlobStore

Returns:

a count of all blobs that are in a listing constrained by the options specified, excluding directory markers

clearContainer

public void clearContainer(String containerName)

This implementation invokes clearContainer(java.lang.String) with the ListContainerOptions.recursive option.

Specified by:

clearContainer in interface BlobStore

Parameters:

containerName - what to clear

clearContainer

public void clearContainer(String containerName,
                  ListContainerOptions options)

Description copied from interface: BlobStore

Like BlobStore.clearContainer(String) except you can use options to do things like recursive deletes, or clear at a different path than root.

Specified by:

clearContainer in interface BlobStore

Parameters:

containerName - what to clear

options - recursion and path to clear

deleteDirectory

public void deleteDirectory(String containerName,
                   String directory)

Description copied from interface: BlobStore

Deletes a folder or a directory marker depending on the service

Specified by:

deleteDirectory in interface BlobStore

directoryExists

public boolean directoryExists(String containerName,
                      String directory)

Description copied from interface: BlobStore

Determines if a directory exists

Specified by:

directoryExists in interface BlobStore

Parameters:

containerName - container where the directory resides

directory - full path to the directory

createDirectory

public void createDirectory(String containerName,
                   String directory)

Description copied from interface: BlobStore

Creates a folder or a directory marker depending on the service

Specified by:

createDirectory in interface BlobStore

Parameters:

containerName - container to create the directory in

directory - full path to the directory

getBlob

public Blob getBlob(String containerName,
           String key)

This implementation invokes getBlob(String,String, GetOptions)

Specified by:

getBlob in interface BlobStore

Parameters:

containerName - container where this exists.

key - fully qualified name relative to the container.

Returns:

the blob you intended to receive or null, if it doesn't exist.

deleteContainer

public void deleteContainer(String containerName)

This implementation invokes deleteAndVerifyContainerGone(java.lang.String)

Specified by:

deleteContainer in interface BlobStore

Parameters:

containerName - what to delete

listAssignableLocations

public Set<? extends org.jclouds.domain.Location> listAssignableLocations()

Description copied from interface: BlobStore

The get locations command returns all the valid locations for containers. A location has a scope, which is typically region or zone. A region is a general area, like eu-west, where a zone is similar to a datacenter. If a location has a parent, that implies it is within that location. For example a location can be a rack, whose parent is likely to be a zone.

Specified by:

listAssignableLocations in interface BlobStore

list

public PageSet<? extends StorageMetadata> list(String containerName,
                                      ListContainerOptions options)

default maxResults is 1000

Specified by:

list in interface BlobStore

Parameters:

containerName - what to list

options - size, recursion, and context of the list

Returns:

a list that may be incomplete, depending on whether PageSet#getNextMarker is set

removeBlob

public void removeBlob(String containerName,
              String key)

Description copied from interface: BlobStore

Deletes a Blob representing the data at location container/name

Specified by:

removeBlob in interface BlobStore

Parameters:

containerName - container where this exists.

key - fully qualified name relative to the container.

removeBlobs

public void removeBlobs(String container,
               Iterable<String> names)

Description copied from interface: BlobStore

Deletes multiple Blobs representing the data at location container/name

Specified by:

removeBlobs in interface BlobStore

Parameters:

container - container where this exists.

names - fully qualified names relative to the container.

getBlobAccess

public BlobAccess getBlobAccess(String container,
                       String name)

Specified by:

getBlobAccess in interface BlobStore

setBlobAccess

public void setBlobAccess(String container,
                 String name,
                 BlobAccess access)

Specified by:

setBlobAccess in interface BlobStore

deleteContainerIfEmpty

public boolean deleteContainerIfEmpty(String containerName)

Description copied from interface: BlobStore

Deletes a container if it is empty.

Specified by:

deleteContainerIfEmpty in interface BlobStore

Parameters:

containerName - name of the container to delete

Returns:

true if the container was deleted or does not exist

containerExists

public boolean containerExists(String containerName)

Description copied from interface: BlobStore

determines if a service-level container exists

Specified by:

containerExists in interface BlobStore

list

public PageSet<? extends StorageMetadata> list()

Description copied from interface: BlobStore

Lists all root-level resources available to the identity.

Specified by:

list in interface BlobStore

createContainerInLocation

public boolean createContainerInLocation(org.jclouds.domain.Location location,
                                String name)

Description copied from interface: BlobStore

Creates a namespace for your blobs

A container is a namespace for your objects. Depending on the service, the scope can be global, identity, or sub-identity scoped. For example, in Amazon S3, containers are called buckets, and they must be uniquely named such that no-one else in the world conflicts. In other blobstores, the naming convention of the container is less strict. All blobstores allow you to list your containers and also the contents within them. These contents can either be blobs, folders, or virtual paths.

Specified by:

createContainerInLocation in interface BlobStore

Parameters:

location - some blobstores allow you to specify a location, such as US-EAST, for where this container will exist. null will choose a default location

name - namespace. Typically constrained to lowercase alpha-numeric and hyphens.

Returns:

true if the container was created, false if it already existed.

getContainerAccess

public ContainerAccess getContainerAccess(String container)

Specified by:

getContainerAccess in interface BlobStore

setContainerAccess

public void setContainerAccess(String container,
                      ContainerAccess access)

Specified by:

setContainerAccess in interface BlobStore

putBlob

public String putBlob(String containerName,
             Blob blob)

Description copied from interface: BlobStore

Adds a Blob representing the data at location container/blob.metadata.name

Specified by:

putBlob in interface BlobStore

Parameters:

containerName - container to place the blob.

blob - fully qualified name relative to the container.

Returns:

etag of the blob you uploaded, possibly null where etags are unsupported

copyBlob

public String copyBlob(String fromContainer,
              String fromName,
              String toContainer,
              String toName,
              CopyOptions options)

Description copied from interface: BlobStore

Copy blob from one container to another. Some providers implement this more efficiently than corresponding getBlob and putBlob operations. Note: options are currently ignored

Specified by:

copyBlob in interface BlobStore

Returns:

ETag of new blob

blobExists

public boolean blobExists(String containerName,
                 String key)

Description copied from interface: BlobStore

Determines if a blob exists

Specified by:

blobExists in interface BlobStore

Parameters:

containerName - container where the blob resides

getBlob

public Blob getBlob(String containerName,
           String key,
           GetOptions options)

Description copied from interface: BlobStore

Retrieves a Blob representing the data at location container/name

Specified by:

getBlob in interface BlobStore

Parameters:

containerName - container where this exists.

key - fully qualified name relative to the container.

options - byte range or condition options

Returns:

the blob you intended to receive or null, if it doesn't exist.

blobMetadata

public BlobMetadata blobMetadata(String containerName,
                        String key)

Description copied from interface: BlobStore

Retrieves the metadata of a Blob at location container/name

Specified by:

blobMetadata in interface BlobStore

Parameters:

containerName - container where this exists.

key - fully qualified name relative to the container.

Returns:

null if name isn't present or the blob you intended to receive.

putBlob

public String putBlob(String containerName,
             Blob blob,
             PutOptions options)

Description copied from interface: BlobStore

Adds a Blob representing the data at location container/blob.metadata.name options using multipart strategies.

Specified by:

putBlob in interface BlobStore

Parameters:

containerName - container to place the blob.

blob - fully qualified name relative to the container.

options - byte range options

Returns:

etag of the blob you uploaded, possibly null where etags are unsupported

createContainerInLocation

public boolean createContainerInLocation(org.jclouds.domain.Location location,
                                String container,
                                CreateContainerOptions options)

Specified by:

createContainerInLocation in interface BlobStore

options - controls default access control

See Also:

BlobStore.createContainerInLocation(Location,String)

initiateMultipartUpload

public MultipartUpload initiateMultipartUpload(String container,
                                      BlobMetadata blobMetadata,
                                      PutOptions options)

Specified by:

initiateMultipartUpload in interface BlobStore

abortMultipartUpload

public void abortMultipartUpload(MultipartUpload mpu)

Specified by:

abortMultipartUpload in interface BlobStore

completeMultipartUpload

public String completeMultipartUpload(MultipartUpload mpu,
                             List<MultipartPart> parts)

Specified by:

completeMultipartUpload in interface BlobStore

uploadMultipartPart

public MultipartPart uploadMultipartPart(MultipartUpload mpu,
                                int partNumber,
                                org.jclouds.io.Payload payload)

Specified by:

uploadMultipartPart in interface BlobStore

listMultipartUpload

public List<MultipartPart> listMultipartUpload(MultipartUpload mpu)

Specified by:

listMultipartUpload in interface BlobStore

listMultipartUploads

public List<MultipartUpload> listMultipartUploads(String container)

Specified by:

listMultipartUploads in interface BlobStore

getMinimumMultipartPartSize

public long getMinimumMultipartPartSize()

Specified by:

getMinimumMultipartPartSize in interface BlobStore

getMaximumMultipartPartSize

public long getMaximumMultipartPartSize()

Specified by:

getMaximumMultipartPartSize in interface BlobStore

getMaximumNumberOfParts

public int getMaximumNumberOfParts()

Specified by:

getMaximumNumberOfParts in interface BlobStore

downloadBlob

public void downloadBlob(String container,
                String name,
                File destination)

Specified by:

downloadBlob in interface BlobStore

downloadBlob

public void downloadBlob(String container,
                String name,
                File destination,
                ExecutorService executor)

Specified by:

downloadBlob in interface BlobStore

streamBlob

public InputStream streamBlob(String container,
                     String name)

Specified by:

streamBlob in interface BlobStore

streamBlob

public InputStream streamBlob(String container,
                     String name,
                     ExecutorService executor)

Specified by:

streamBlob in interface BlobStore