Package org.elasticsearch.common.blobstore.fs

Class FsBlobContainer

java.lang.Object

org.elasticsearch.common.blobstore.support.AbstractBlobContainer

org.elasticsearch.common.blobstore.fs.FsBlobContainer

All Implemented Interfaces:

BlobContainer

public class FsBlobContainer
extends AbstractBlobContainer

A file system based implementation of BlobContainer. All blobs in the container are stored on a file system, the location of which is specified by the BlobPath. Note that the methods in this implementation of BlobContainer may additionally throw a SecurityException if the configured SecurityManager does not permit read and/or write access to the underlying files.

Field Summary

Fields

Modifier and Type	Field	Description
protected FsBlobStore	blobStore
protected Path	path

Constructor Summary

Constructors

Constructor	Description
FsBlobContainer(FsBlobStore blobStore, BlobPath blobPath, Path path)

Method Summary

Modifier and Type	Method	Description
Map<String,BlobContainer>	children()	Lists all child containers under this container.
DeleteResult	delete()	Deletes this container and all its contents from the repository.
void	deleteBlob(String blobName)	Deletes the blob with the given name, if the blob exists.
static boolean	isTempBlobName(String blobName)	Returns true if the blob is a leftover temporary blob.
Map<String,BlobMetaData>	listBlobs()	Lists all blobs in the container.
Map<String,BlobMetaData>	listBlobsByPrefix(String blobNamePrefix)	Lists all blobs in the container that match the specified prefix.
void	moveBlobAtomic(String sourceBlobName, String targetBlobName, boolean failIfAlreadyExists)
InputStream	readBlob(String name)	Creates a new InputStream for the given blob name.
static String	tempBlobName(String blobName)
void	writeBlob(String blobName, InputStream inputStream, long blobSize, boolean failIfAlreadyExists)	Reads blob content from the input stream and writes it to the container in a new blob with the given name.
void	writeBlobAtomic(String blobName, InputStream inputStream, long blobSize, boolean failIfAlreadyExists)	Reads blob content from the input stream and writes it to the container in a new blob with the given name, using an atomic write operation if the implementation supports it.

Methods inherited from class org.elasticsearch.common.blobstore.support.AbstractBlobContainer

path

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.blobstore.BlobContainer

deleteBlobIgnoringIfNotExists, deleteBlobsIgnoringIfNotExists

Field Detail

blobStore

protected final FsBlobStore blobStore

path

protected final Path path

Constructor Detail

FsBlobContainer

public FsBlobContainer(FsBlobStore blobStore,
                       BlobPath blobPath,
                       Path path)

Method Detail

listBlobs

public Map<String,BlobMetaData> listBlobs()
                                         throws IOException

Description copied from interface: BlobContainer

Lists all blobs in the container.

Returns:

A map of all the blobs in the container. The keys in the map are the names of the blobs and the values are BlobMetaData, containing basic information about each blob.

Throws:

IOException - if there were any failures in reading from the blob container.

children

public Map<String,BlobContainer> children()
                                         throws IOException

Description copied from interface: BlobContainer

Lists all child containers under this container. A child container is defined as a container whose BlobContainer.path() method returns a path that has this containers BlobContainer.path() return as its prefix and has one more path element than the current container's path.

Returns:

Map of name of the child container to child container

Throws:

IOException - on failure to list child containers

listBlobsByPrefix

public Map<String,BlobMetaData> listBlobsByPrefix(String blobNamePrefix)
                                                 throws IOException

Description copied from interface: BlobContainer

Lists all blobs in the container that match the specified prefix.

Parameters:

blobNamePrefix - The prefix to match against blob names in the container.

Returns:

A map of the matching blobs in the container. The keys in the map are the names of the blobs and the values are BlobMetaData, containing basic information about each blob.

Throws:

IOException - if there were any failures in reading from the blob container.

deleteBlob

public void deleteBlob(String blobName)
                throws IOException

Description copied from interface: BlobContainer

Deletes the blob with the given name, if the blob exists. If the blob does not exist, this method may throw a NoSuchFileException if the underlying implementation supports an existence check before delete.

Parameters:

blobName - The name of the blob to delete.

Throws:

NoSuchFileException - if the blob does not exist

IOException - if the blob exists but could not be deleted.

delete

public DeleteResult delete()
                    throws IOException

Description copied from interface: BlobContainer

Deletes this container and all its contents from the repository.

Returns:

delete result

Throws:

IOException - on failure

readBlob

public InputStream readBlob(String name)
                     throws IOException

Description copied from interface: BlobContainer

Creates a new InputStream for the given blob name.

Parameters:

name - The name of the blob to get an InputStream for.

Returns:

The InputStream to read the blob.

Throws:

NoSuchFileException - if the blob does not exist

IOException - if the blob can not be read.

writeBlob

public void writeBlob(String blobName,
                      InputStream inputStream,
                      long blobSize,
                      boolean failIfAlreadyExists)
               throws IOException

Description copied from interface: BlobContainer

Reads blob content from the input stream and writes it to the container in a new blob with the given name. This method assumes the container does not already contain a blob of the same blobName. If a blob by the same name already exists, the operation will fail and an IOException will be thrown.

Parameters:

blobName - The name of the blob to write the contents of the input stream to.

inputStream - The input stream from which to retrieve the bytes to write to the blob.

blobSize - The size of the blob to be written, in bytes. It is implementation dependent whether this value is used in writing the blob to the repository.

failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists

Throws:

FileAlreadyExistsException - if failIfAlreadyExists is true and a blob by the same name already exists

IOException - if the input stream could not be read, or the target blob could not be written to.

writeBlobAtomic

public void writeBlobAtomic(String blobName,
                            InputStream inputStream,
                            long blobSize,
                            boolean failIfAlreadyExists)
                     throws IOException

Description copied from interface: BlobContainer

Reads blob content from the input stream and writes it to the container in a new blob with the given name, using an atomic write operation if the implementation supports it. This method assumes the container does not already contain a blob of the same blobName. If a blob by the same name already exists, the operation will fail and an IOException will be thrown.

Parameters:

blobName - The name of the blob to write the contents of the input stream to.

inputStream - The input stream from which to retrieve the bytes to write to the blob.

blobSize - The size of the blob to be written, in bytes. It is implementation dependent whether this value is used in writing the blob to the repository.

failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists

Throws:

FileAlreadyExistsException - if failIfAlreadyExists is true and a blob by the same name already exists

IOException - if the input stream could not be read, or the target blob could not be written to.

moveBlobAtomic

public void moveBlobAtomic(String sourceBlobName,
                           String targetBlobName,
                           boolean failIfAlreadyExists)
                    throws IOException

Throws:

IOException

tempBlobName

public static String tempBlobName(String blobName)

isTempBlobName

public static boolean isTempBlobName(String blobName)

Returns true if the blob is a leftover temporary blob. The temporary blobs might be left after failed atomic write operation.