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 java.nio.file.Path	path

Constructor Summary

Constructors

Constructor	Description
FsBlobContainer(FsBlobStore blobStore, BlobPath blobPath, java.nio.file.Path path)

Method Summary

Modifier and Type	Method	Description
boolean	blobExists(java.lang.String blobName)	Tests whether a blob with the given blob name exists in the container.
void	deleteBlob(java.lang.String blobName)	Deletes a blob with giving name, if the blob exists.
java.util.Map<java.lang.String,BlobMetaData>	listBlobs()	Lists all blobs in the container.
java.util.Map<java.lang.String,BlobMetaData>	listBlobsByPrefix(java.lang.String blobNamePrefix)	Lists all blobs in the container that match the specified prefix.
void	move(java.lang.String source, java.lang.String target)	Renames the source blob into the target blob.
java.io.InputStream	readBlob(java.lang.String name)	Creates a new InputStream for the given blob name.
void	writeBlob(java.lang.String blobName, java.io.InputStream inputStream, long blobSize)	Reads blob content from the input stream and writes it to the container in a new blob with the given name.

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

Field Detail

blobStore

protected final FsBlobStore blobStore

path

protected final java.nio.file.Path path

Constructor Detail

FsBlobContainer

public FsBlobContainer(FsBlobStore blobStore,
                       BlobPath blobPath,
                       java.nio.file.Path path)

Method Detail

listBlobs

public java.util.Map<java.lang.String,BlobMetaData> listBlobs()
                                                       throws java.io.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:

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

listBlobsByPrefix

public java.util.Map<java.lang.String,BlobMetaData> listBlobsByPrefix(java.lang.String blobNamePrefix)
                                                               throws java.io.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:

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

deleteBlob

public void deleteBlob(java.lang.String blobName)
                throws java.io.IOException

Description copied from interface: BlobContainer

Deletes a blob with giving name, if the blob exists. If the blob does not exist, this method throws an IOException.

Parameters:

blobName - The name of the blob to delete.

Throws:

java.nio.file.NoSuchFileException - if the blob does not exist

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

blobExists

public boolean blobExists(java.lang.String blobName)

Description copied from interface: BlobContainer

Tests whether a blob with the given blob name exists in the container.

Parameters:

blobName - The name of the blob whose existence is to be determined.

Returns:

true if a blob exists in the BlobContainer with the given name, and false otherwise.

readBlob

public java.io.InputStream readBlob(java.lang.String name)
                             throws java.io.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:

java.nio.file.NoSuchFileException - if the blob does not exist

java.io.IOException - if the blob can not be read.

writeBlob

public void writeBlob(java.lang.String blobName,
                      java.io.InputStream inputStream,
                      long blobSize)
               throws java.io.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.

Throws:

java.nio.file.FileAlreadyExistsException - if a blob by the same name already exists

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

move

public void move(java.lang.String source,
                 java.lang.String target)
          throws java.io.IOException

Description copied from interface: BlobContainer

Renames the source blob into the target blob. If the source blob does not exist or the target blob already exists, an exception is thrown. Atomicity of the move operation can only be guaranteed on an implementation-by-implementation basis. The only current implementation of BlobContainer for which atomicity can be guaranteed is the FsBlobContainer.

Parameters:

source - The blob to rename.

target - The name of the blob after the renaming.

Throws:

java.io.IOException - if the source blob does not exist, the target blob already exists, or there were any failures in reading from the blob container.