org.elasticsearch.common.blobstore

Interface BlobContainer

All Known Implementing Classes:

AbstractBlobContainer, AbstractLegacyBlobContainer, FsBlobContainer, URLBlobContainer

public interface BlobContainer

Method Summary

Methods

Modifier and Type	Method and Description
boolean	blobExists(String blobName)
void	deleteBlob(String blobName) Deletes a blob with giving name.
void	deleteBlobs(Collection<String> blobNames) Deprecated. Removing this method in 5.0 in favor of using deleteBlob(String) as the there are no atomic guarantees to deleting multiple blobs in the same call and the corresponding exception handling is best left to the invoker.
void	deleteBlobsByPrefix(String blobNamePrefix) Deprecated. Removing this method in 5.0 in favor of using deleteBlob(String) as the there are no atomic guarantees to deleting multiple blobs in the same call and the corresponding exception handling is best left to the invoker.
Map<String,BlobMetaData>	listBlobs() Lists all blobs in the container
Map<String,BlobMetaData>	listBlobsByPrefix(String blobNamePrefix) Lists all blobs in the container that match specified prefix
void	move(String sourceBlobName, String targetBlobName) Atomically renames source blob into target blob
BlobPath	path()
InputStream	readBlob(String blobName) Creates a new InputStream for the given blob name
void	writeBlob(String blobName, BytesReference bytes) Deprecated. Use writeBlob(String, InputStream, long) instead.
void	writeBlob(String blobName, InputStream inputStream, long blobSize) Reads blob content from the input stream and writes it to the blob store

Method Detail

path

BlobPath path()

blobExists

boolean blobExists(String blobName)

readBlob

InputStream readBlob(String blobName)
                     throws IOException

Creates a new InputStream for the given blob name

Throws:

IOException

writeBlob

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

Reads blob content from the input stream and writes it to the blob store

Throws:

IOException

writeBlob

@Deprecated
void writeBlob(String blobName,
                        BytesReference bytes)
               throws IOException

Deprecated. Use writeBlob(String, InputStream, long) instead.

Writes bytes to the blob

Throws:

IOException

deleteBlob

void deleteBlob(String blobName)
                throws IOException

Deletes a blob with giving name. If a blob exists but cannot be deleted an exception has to be thrown.

Throws:

IOException

deleteBlobs

@Deprecated
void deleteBlobs(Collection<String> blobNames)
                 throws IOException

Deprecated. Removing this method in 5.0 in favor of using deleteBlob(String) as the there are no atomic guarantees to deleting multiple blobs in the same call and the corresponding exception handling is best left to the invoker.

Deletes blobs with giving names. If a blob exists but cannot be deleted an exception has to be thrown.

Throws:

IOException

deleteBlobsByPrefix

@Deprecated
void deleteBlobsByPrefix(String blobNamePrefix)
                         throws IOException

Deprecated. Removing this method in 5.0 in favor of using deleteBlob(String) as the there are no atomic guarantees to deleting multiple blobs in the same call and the corresponding exception handling is best left to the invoker.

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

Throws:

IOException

listBlobs

Map<String,BlobMetaData> listBlobs()
                                   throws IOException

Lists all blobs in the container

Throws:

IOException

listBlobsByPrefix

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

Lists all blobs in the container that match specified prefix

Throws:

IOException

move

void move(String sourceBlobName,
        String targetBlobName)
          throws IOException

Atomically renames source blob into target blob

Throws:

IOException